Code quality improvements and comprehensive documentation #611
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: | |
| push: | |
| branches: [master] | |
| pull_request: | |
| branches: [master] | |
| jobs: | |
| build: | |
| runs-on: ubuntu-22.04 | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Install Debian packages | |
| run: | | |
| sudo apt-get update -qq | |
| sudo apt-get install -y python3-pip make | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: 3.12 | |
| - name: Install dependencies | |
| run: | | |
| python3 -m venv venv | |
| venv/bin/pip install --upgrade pip | |
| venv/bin/pip install ".[doc,cli]" | |
| - name: Run doc | |
| run: venv/bin/sphinx-build -N -bhtml doc/ doc/_build -W |