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: Deploy Sphinx documentation to Pages | |
| on: | |
| pull_request: | |
| types: [opened, synchronize] | |
| paths: | |
| - 'docs/sphinx_doc/**/*' | |
| push: | |
| branches: | |
| - sphinxdoc_page | |
| jobs: | |
| pages: | |
| runs-on: ubuntu-20.04 | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Setup Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@master | |
| with: | |
| python_version: ${{ matrix.python-version }} | |
| - name: Choose which pandoc to use | |
| shell: bash | |
| run: | | |
| case $RUNNER_OS in | |
| "Linux") | |
| printf 'INSTALLER_SUFFIX=1-amd64.deb' >> $GITHUB_ENV | |
| ;; | |
| "macOS") | |
| printf 'INSTALLER_SUFFIX=macOS.pkg' >> $GITHUB_ENV | |
| ;; | |
| *) | |
| printf 'Do not know how to install pandoc on %s\n' "$RUNNER_OS" | |
| exit 1 | |
| ;; | |
| esac | |
| - name: Download pandoc installer | |
| shell: bash | |
| env: | |
| GITHUB_TOKEN: ${{ github.token }} | |
| REPO: jgm/pandoc | |
| DOWNLOAD_URL: 'https://github.com/jgm/pandoc/releases/download/' | |
| run: | | |
| gh release download ${{ inputs.version }} \ | |
| --repo "$REPO" \ | |
| --pattern '*'${{ env.INSTALLER_SUFFIX }} | |
| printf 'INSTALLER_VERSION=%s' \ | |
| "$(ls pandoc-*-${{ env.INSTALLER_SUFFIX }} | \ | |
| sed 's/pandoc-\([0-9.]*\)-.*/\1/')" \ | |
| >> $GITHUB_ENV | |
| - name: Install pandoc | |
| shell: bash | |
| env: | |
| INSTALLER: pandoc-${{ env.INSTALLER_VERSION }}-${{ env.INSTALLER_SUFFIX }} | |
| run: | | |
| case $RUNNER_OS in | |
| "Linux") | |
| sudo apt install ./$INSTALLER | |
| ;; | |
| "macOS") | |
| sudo installer -pkg ./$INSTALLER -target '/' | |
| ;; | |
| *) | |
| echo "$RUNNER_OS not supported" | |
| exit 1 | |
| ;; | |
| esac | |
| rm $INSTALLER | |
| - name: Install sphinx dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install -r docs/sphinx_doc/requirements.txt | |
| - name: Build documentation | |
| run: | | |
| cd docs/sphinx_doc | |
| bash build_sphinx_doc.sh | |
| - name: Upload documentation | |
| uses: actions/upload-artifact@v3 | |
| with: | |
| name: SphinxDoc | |
| path: 'docs/sphinx_doc/build/html' | |
| - uses: peaceiris/actions-gh-pages@v3 | |
| if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/sphinxdoc_page' }} | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: 'docs/sphinx_doc/build/html' |