Updated documentation #38
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: Docs | |
| on: [push, pull_request] | |
| jobs: | |
| build_doc: | |
| name: Docs (PR comments) | |
| runs-on: ubuntu-latest | |
| env: | |
| BUILD_DEPS: python3-dev build-essential graphviz | |
| LATEX_DEPS: dvipng latexmk texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended | |
| steps: | |
| - uses: actions/checkout@v3.3.0 | |
| - uses: ericpre/sphinx-action@latest_sphinx | |
| with: | |
| pre-build-command: "apt-get update -y && apt-get install -y ${{ env.BUILD_DEPS }} ${{ env.LATEX_DEPS }} && apt-get install -y git && pip install .[all,doc] && make demos" | |
| build-command: make html | |
| docs-folder: doc/ | |
| - uses: actions/upload-artifact@v3 | |
| with: | |
| path: ./doc/_build/html/ | |
| name: doc_build | |
| check_links: | |
| # This build is to check external links | |
| name: Check external links | |
| runs-on: ubuntu-latest | |
| env: | |
| DOCS_PATH: ./doc/_build/html/ | |
| steps: | |
| - uses: actions/checkout@v3.3.0 | |
| with: | |
| fetch-depth: 0 | |
| - uses: actions/setup-python@v4 | |
| name: Install Python | |
| with: | |
| python-version: '3.11' | |
| - name: Install build docs | |
| shell: bash -l {0} | |
| run: | | |
| pip install .[doc] | |
| - name: Check links | |
| shell: bash -l {0} | |
| run: | | |
| cd doc | |
| make linkcheck |