Fix links #134
This file contains hidden or 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: Build & Deploy docs site to GitHub Pages | |
| on: | |
| push: | |
| branches: [develop] | |
| pull_request: | |
| branches: [develop] | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@9bb56186c3b09b4f86b1c65136769dd318469633 | |
| - name: Setup Python | |
| uses: actions/setup-python@82c7e631bb3cdc910f68e0081d67478d79c6982d | |
| with: | |
| python-version: '3.11' | |
| cache: 'pip' | |
| cache-dependency-path: '.github/workflows/requirements/docs.txt' | |
| - name: Setup GitHub Pages | |
| id: pages | |
| uses: actions/configure-pages@983d7736d9b0ae728b81ab479565c72886d7745b | |
| - name: Install Sphinx and Theme via Pip | |
| run: | | |
| pip install -r .github/workflows/requirements/docs.txt | |
| - name: Install Gnuplot | |
| run: | | |
| sudo apt update | |
| sudo apt install -y gnuplot | |
| - name: Build with sphinx | |
| run: | | |
| cd docs | |
| # make html WORKSPACE_PATH=/tmp/workspace | |
| ./build_doc.py --html | |
| - name: Check for Typos using Codespell | |
| run: | | |
| codespell --ignore-words=.codespellignore | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa | |
| with: | |
| path: ./docs/_build/html | |
| deploy: | |
| needs: build | |
| if: github.ref == 'refs/heads/develop' | |
| permissions: | |
| pages: write | |
| id-token: write | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e |