Skip to content

Commit

Permalink
Documentation - Add GH overview documentation build #200
Browse files Browse the repository at this point in the history
  • Loading branch information
dpasukhi committed Dec 18, 2024
1 parent 73ec4a5 commit 1dfcac2
Showing 1 changed file with 16 additions and 6 deletions.
22 changes: 16 additions & 6 deletions .github/workflows/build-docs.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# This workflow builds the OCCT reference manual documentation.
# This workflow builds the OCCT reference manual and overview documentations.
# It is triggered on pushes to the 'master' branch.
# The workflow includes steps to checkout the repository, install dependencies, build the documentation, and upload the generated documentation and logs as artifacts.

Expand All @@ -8,9 +8,6 @@ on:
push:
branches:
- 'master'
pull_request:
branches:
- '**'

jobs:
build:
Expand All @@ -26,7 +23,7 @@ jobs:
choco install -y graphviz
choco install -y doxygen.install
- name: Build documentation
- name: Build refman documentation
run: |
set PATH=%PATH%;C:\Program Files\doxygen\bin;C:\Program Files\Graphviz\bin;C:\Program Files\doxygen
cd adm
Expand All @@ -35,7 +32,6 @@ jobs:

- name: Upload refman documentation
uses: actions/[email protected]
id: artifact-upload-step
with:
name: refman-doc
path: doc/refman
Expand All @@ -47,3 +43,17 @@ jobs:
name: doxygen.log
path: doc/html_doxygen_err.log
retention-days: 90

- name: Build documentation Overview
run: |
set PATH=%PATH%;C:\Program Files\doxygen\bin;C:\Program Files\Graphviz\bin;C:\Program Files\doxygen
cd adm
bash gendoc -overview
shell: cmd

- name: Upload overview documentation
uses: actions/[email protected]
with:
name: overview-doc
path: doc/overview
retention-days: 90

0 comments on commit 1dfcac2

Please sign in to comment.