]> OCCT Git - occt.git/commitdiff
Documentation - Add GH overview documentation build #200
authordpasukhi <dpasukhi@opencascade.com>
Wed, 18 Dec 2024 10:01:13 +0000 (10:01 +0000)
committerdpasukhi <dpasukhi@opencascade.com>
Wed, 18 Dec 2024 10:17:02 +0000 (10:17 +0000)
.github/workflows/build-docs.yml

index 27896aa9874978e76ceef5c402e10d9b7b4b9369..ec257120cdc211145eb5a8ea68b7a0e9ac534382 100644 (file)
@@ -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.
 
@@ -8,9 +8,6 @@ on:
   push:
     branches:
       - 'master'
-  pull_request:
-    branches:
-      - '**'
 
 jobs:
   build:
@@ -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
@@ -35,7 +32,6 @@ jobs:
 
     - name: Upload refman documentation
       uses: actions/upload-artifact@v4.4.3
-      id: artifact-upload-step
       with:
         name: refman-doc
         path: doc/refman
@@ -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/upload-artifact@v4.4.3
+      with:
+        name: overview-doc
+        path: doc/overview
+        retention-days: 90