Move pyrealm_build_data documentation into an autodoc style setup
#1450
Workflow file for this run
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: Test and build | |
| # When does this run - new, reopened or updated PRs, pushes to main or develop and when | |
| # the workflow is called by another workflow, such as the publishing actions. | |
| on: | |
| pull_request: | |
| types: [opened, synchronize, reopened] | |
| workflow_call: | |
| jobs: | |
| qa: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.11" | |
| - uses: pre-commit/[email protected] | |
| test: | |
| needs: qa | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| os: [ ubuntu-latest, macos-latest, windows-latest ] | |
| python-version: ["3.10", "3.11", "3.12"] | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| ref: ${{ github.head_ref }} | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Install Poetry | |
| uses: abatilo/[email protected] | |
| with: | |
| poetry-version: 1.2.2 | |
| - name: Install dependencies | |
| run: poetry install | |
| - name: Run tests | |
| run: poetry run pytest -m "not profiling" --cov-report xml | |
| - name: Upload coverage reports to Codecov | |
| id: codecov | |
| if: success() && (matrix.os == 'ubuntu-latest' && matrix.python-version == 3.10) | |
| uses: codecov/codecov-action@v3 | |
| env: | |
| CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }} | |
| docs_build: | |
| needs: qa | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.11" | |
| - name: Install Poetry | |
| uses: abatilo/[email protected] | |
| with: | |
| poetry-version: 1.2.2 | |
| - name: Install dependencies | |
| run: poetry install | |
| - name: Build docs using sphinx | |
| run: | | |
| cd docs | |
| poetry run sphinx-build -W --keep-going source build | |
| - name: Archive built docs for error checking on failure | |
| if: failure() | |
| uses: actions/upload-artifact@v3 | |
| with: | |
| name: built-docs | |
| path: docs/build | |
| retention-days: 2 |