Report Derivations (#1148) #1291
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: "Documentation" | |
| on: | |
| pull_request: | |
| push: | |
| branches: | |
| - 'master' | |
| jobs: | |
| build: | |
| name: "Build" | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: "Checkout code" | |
| uses: actions/checkout@v3 | |
| - name: "Set up Python 3.9" | |
| uses: actions/setup-python@v3 | |
| with: | |
| python-version: '3.9' # Semantic version range syntax or exact version of a Python version | |
| - name: "Display Python version" | |
| run: python -c "import sys; print(sys.version)" | |
| - name: "Update apt" | |
| run: sudo apt-get update | |
| - name: "Install Sphinx dependencies" | |
| run: sudo apt-get install python3-dev build-essential | |
| - name: "Cache pip" | |
| uses: actions/cache@v4 | |
| with: | |
| path: ~/.cache/pip | |
| key: ${{ runner.os }}-pip-${{ hashFiles('docs/conf.py') }} | |
| restore-keys: | | |
| ${{ runner.os }}-pip- | |
| - name: "Install Sphinx + requirements via pip" | |
| working-directory: "docs" | |
| run: pip3 install -r requirements.txt | |
| - name: "Build documentation" | |
| working-directory: "docs" | |
| run: make -C . SPHINXOPTS="-nqW -j auto" html | |
| doctor-rst: | |
| name: "DOCtor-RST" | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: "Checkout code" | |
| uses: actions/checkout@v3 | |
| - name: "Run DOCtor-RST" | |
| uses: docker://oskarstark/doctor-rst | |
| with: | |
| args: --short | |
| env: | |
| DOCS_DIR: 'docs/' |