Nightly Documentation Build #1045
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Nightly Documentation Build | ||
| on: | ||
| workflow_dispatch: | ||
| schedule: # UTC at 0300 | ||
| - cron: '0 3 * * *' | ||
| env: | ||
| ANSYSLMD_LICENSE_FILE: ${{ format('1055@{0}', secrets.LICENSE_SERVER) }} | ||
| MAIN_PYTHON_VERSION: '3.10' | ||
| DOCUMENTATION_CNAME: 'aedt.docs.pyansys.com' | ||
| MEILISEARCH_API_KEY: ${{ secrets.MEILISEARCH_API_KEY }} | ||
| MEILISEARCH_PUBLIC_API_KEY: ${{ secrets.MEILISEARCH_PUBLIC_API_KEY }} | ||
| concurrency: | ||
| group: ${{ github.workflow }}-${{ github.ref }} | ||
| cancel-in-progress: true | ||
| jobs: | ||
| doc-build: | ||
|
Check failure on line 20 in .github/workflows/nightly-docs.yml
|
||
| name: Documentation build without examples | ||
| runs-on: ubuntu-latest | ||
| needs: [doc-style] | ||
| steps: | ||
| - name: Install Git and checkout project | ||
| uses: actions/checkout@v4 | ||
| - name: Setup Python | ||
| uses: actions/setup-python@v5 | ||
| with: | ||
| python-version: ${{ env.MAIN_PYTHON_VERSION }} | ||
| - name: Update pip | ||
| run: | | ||
| pip install --upgrade pip | ||
| - name: Install pyaedt and documentation dependencies | ||
| run: | | ||
| pip install .[doc-no-examples] | ||
| - name: Retrieve PyAEDT version | ||
| id: version | ||
| run: | | ||
| echo "PYAEDT_VERSION=$(python -c 'from pyaedt import __version__; print(__version__)')" >> $GITHUB_OUTPUT | ||
| echo "PyAEDT version is: $(python -c "from pyaedt import __version__; print(__version__)")" | ||
| - name: Install doc build requirements | ||
| run: | | ||
| sudo apt update | ||
| sudo apt install graphviz texlive-latex-extra latexmk texlive-xetex texlive-fonts-extra -y | ||
| # TODO: Update this step once pyaedt-examples is ready | ||
| - name: Build HTML documentation without examples | ||
| run: | | ||
| make -C doc clean | ||
| make -C doc html-no-examples | ||
| # Verify that sphinx generates no warnings | ||
| - name: Check for warnings | ||
| run: | | ||
| python doc/print_errors.py | ||
| - name: Build PDF documentation without examples | ||
| run: | | ||
| make -C doc pdf-no-examples | ||
| - name: Add assets to HTML docs | ||
| run: | | ||
| zip -r documentation-html.zip ./doc/_build/html | ||
| mv documentation-html.zip ./doc/_build/html/_static/assets/download/ | ||
| cp doc/_build/latex/PyAEDT-Documentation-*.pdf ./doc/_build/html/_static/assets/download/pyaedt.pdf | ||
| - name: Upload HTML documentation without examples artifact | ||
| uses: actions/upload-artifact@v3 | ||
| with: | ||
| name: documentation-no-examples-html | ||
| path: doc/_build/html | ||
| retention-days: 7 | ||
| - name: Upload PDF documentation without examples artifact | ||
| uses: actions/upload-artifact@v3 | ||
| with: | ||
| name: documentation-pdf | ||
| path: doc/_build/latex/PyAEDT-Documentation-*.pdf | ||
| retention-days: 7 | ||
| upload-dev-doc: | ||
| name: Upload dev documentation | ||
| runs-on: ubuntu-latest | ||
| needs: [doc-build] | ||
| steps: | ||
| - name: Upload development documentation | ||
| uses: ansys/actions/doc-deploy-dev@v4 | ||
| with: | ||
| cname: ${{ env.DOCUMENTATION_CNAME }} | ||
| token: ${{ secrets.GITHUB_TOKEN }} | ||
| doc-artifact-name: 'documentation-no-examples-html' | ||
| doc-index-dev: | ||
| name: Deploy dev index docs | ||
| runs-on: ubuntu-latest | ||
| needs: upload-dev-doc | ||
| steps: | ||
| - name: Deploy the latest documentation index | ||
| uses: ansys/actions/doc-deploy-index@v4 | ||
| with: | ||
| cname: ${{ env.DOCUMENTATION_CNAME }}/version/dev | ||
| index-name: pyaedt-vdev | ||
| host-url: ${{ env.MEILISEARCH_HOST_URL }} | ||
| api-key: ${{ env.MEILISEARCH_API_KEY }} | ||
| python-version: ${{ env.MAIN_PYTHON_VERSION }} | ||
