Repository navigation
v3.1.0: perf + memory + ordering docs (#75, #113, #65) #48
Workflow file for this run
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 docs (PR check) | |
| on: | |
| pull_request: | |
| paths: | |
| - 'doc/**' | |
| - 'src/**' | |
| - 'pyproject.toml' | |
| - '.github/workflows/docs-pr.yml' | |
| permissions: | |
| contents: read | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.13' | |
| cache: 'pip' | |
| cache-dependency-path: pyproject.toml | |
| - name: Install docs deps | |
| # [legacy] pulls in the gdxcc PyPI binding, which is importable | |
| # without a real GAMS install and provides the integer constants | |
| # that gdxpds.gdx and gdxpds.special reference at module load. | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install -e .[docs,legacy] | |
| - name: Build Sphinx (warnings-as-errors) | |
| working-directory: doc | |
| run: sphinx-build -W --keep-going -b html source build/html | |
| - uses: actions/upload-artifact@v4 | |
| with: | |
| name: docs-html | |
| path: doc/build/html | |
| retention-days: 14 |