Skip json build for docs build. (#146)

Co-authored-by: Roberto Pastor Muela <[email protected]>
ansys · Jan 23, 2023 · cb6add4 · cb6add4
1 parent e2ccfeb
commit cb6add4
Show file tree

Hide file tree

Showing 10 changed files with 26 additions and 14 deletions.
diff --git a/build-ci-wheels/action.yml b/build-ci-wheels/action.yml
@@ -33,7 +33,7 @@ inputs:
       required: false
       type: boolean
   checkout:
-      description: 'Whether to checkout the repository or not'
+      description: 'Whether to checkout the repository or not.'
       default: true
       required: false
       type: boolean

diff --git a/build-library/action.yml b/build-library/action.yml
@@ -17,7 +17,7 @@ inputs:
     default: true
     type: boolean
   checkout:
-      description: 'Whether to checkout the repository or not'
+      description: 'Whether to checkout the repository or not.'
       default: true
       required: false
       type: boolean

diff --git a/build-wheelhouse/action.yml b/build-wheelhouse/action.yml
@@ -29,7 +29,7 @@ inputs:
     default: ''
     type: string
   checkout:
-      description: 'Whether to checkout the repository or not'
+      description: 'Whether to checkout the repository or not.'
       default: true
       required: false
       type: boolean

diff --git a/check-licenses/action.yml b/check-licenses/action.yml
@@ -23,7 +23,7 @@ inputs:
     default: ''
     type: string
   checkout:
-      description: 'Whether to checkout the repository or not'
+      description: 'Whether to checkout the repository or not.'
       default: true
       required: false
       type: boolean

diff --git a/code-style/action.yml b/code-style/action.yml
@@ -13,7 +13,7 @@ inputs:
     default: true
     type: boolean
   checkout:
-      description: 'Whether to checkout the repository or not'
+      description: 'Whether to checkout the repository or not.'
       default: true
       required: false
       type: boolean

diff --git a/doc-build/action.yml b/doc-build/action.yml
@@ -33,7 +33,12 @@ inputs:
       required: false
       type: boolean
   checkout:
-      description: 'Whether to checkout the repository or not'
+      description: 'Whether to checkout the repository or not.'
+      default: true
+      required: false
+      type: boolean
+  skip-json-build:
+      description: 'Whether to build json files or not.'
       default: true
       required: false
       type: boolean
@@ -98,22 +103,28 @@ runs:
       shell: bash
       if: env.EXISTS_DOC_REQUIREMENTS == 'false'
       run: python -m pip install .[doc]
-    
+
     - name: "Build HTML, PDF, and JSON documentation"
       if: inputs.requires-xvfb == 'false'
       shell: bash
       run: |
         make -C doc html SPHINXOPTS="${{ inputs.sphinxopts }}"
         make -C doc pdf
-        make -C doc json SPHINXOPTS="${{ inputs.sphinxopts }}"
+        if [[ ${{ inputs.skip-json-build == 'false' }} ]];
+        then
+          make -C doc json SPHINXOPTS="${{ inputs.sphinxopts }}"
+        fi
 
-    - name: "Build HTML and JSON documentation using xvfb"
+    - name: "Build HTML, PDF, and JSON documentation using xvfb"
       if: inputs.requires-xvfb == 'true'
       shell: bash
       run: |
         xvfb-run make -C doc html SPHINXOPTS="${{ inputs.sphinxopts }}"
         xvfb-run make -C doc pdf
-        xvfb-run make -C doc json SPHINXOPTS="${{ inputs.sphinxopts }}"
+        if [[ ${{ inputs.skip-json-build == 'false' }} ]];
+        then
+          xvfb-run make -C doc json SPHINXOPTS="${{ inputs.sphinxopts }}"
+        fi
 
     - name: "Upload HTML documentation artifact"
       uses: actions/upload-artifact@v3
@@ -131,6 +142,7 @@ runs:
 
     - name: "Upload JSON documentation artifact"
       uses: actions/upload-artifact@v3
+      if: inputs.skip-json-build == 'false'
       with:
         name: documentation-json
         path: doc/_build/json

diff --git a/doc-deploy-stable/action.yml b/doc-deploy-stable/action.yml
@@ -36,7 +36,7 @@ inputs:
     required: false
     type: string
   checkout:
-      description: 'Whether to checkout the repository or not'
+      description: 'Whether to checkout the repository or not.'
       default: true
       required: false
       type: boolean

diff --git a/doc-deploy-to-repo/action.yml b/doc-deploy-to-repo/action.yml
@@ -19,7 +19,7 @@ inputs:
     required: true
     type: string
   checkout:
-      description: 'Whether to checkout the repository or not'
+      description: 'Whether to checkout the repository or not.'
 
       default: true
       required: false

diff --git a/doc-style/action.yml b/doc-style/action.yml
@@ -12,7 +12,7 @@ inputs:
     required: true
     type: string
   checkout:
-      description: 'Whether to checkout the repository or not'
+      description: 'Whether to checkout the repository or not.'
       default: true
       required: false
       type: boolean

diff --git a/tests-pytest/action.yml b/tests-pytest/action.yml
@@ -32,7 +32,7 @@ inputs:
       required: false
       type: boolean
   checkout:
-      description: 'Whether to checkout the repository or not'
+      description: 'Whether to checkout the repository or not.'
       default: true
       required: false
       type: boolean