docs: fix two Sphinx warnings #141
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: CI | |
| on: | |
| push: | |
| branches: [main] | |
| pull_request: | |
| branches: [main] | |
| # MADDENING is a private repo in the same org. The test job uses | |
| # the MADDENING_TOKEN secret (a fine-grained PAT with Contents:read | |
| # on Microrobotics-Simulation-Framework/MADDENING). | |
| jobs: | |
| # ── Detect what changed ──────────────────────────────────────────────── | |
| changes: | |
| runs-on: ubuntu-latest | |
| outputs: | |
| code: ${{ steps.filter.outputs.code }} | |
| docs: ${{ steps.filter.outputs.docs }} | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: dorny/paths-filter@v3 | |
| id: filter | |
| with: | |
| filters: | | |
| code: | |
| - 'src/**' | |
| - 'tests/**' | |
| - 'pyproject.toml' | |
| - '.github/workflows/ci.yml' | |
| docs: | |
| - 'docs/**' | |
| - 'scripts/**' | |
| - 'src/**' | |
| - '.github/workflows/ci.yml' | |
| # ── Compliance checks (runs on doc or code changes) ──────────────────── | |
| compliance: | |
| needs: changes | |
| if: ${{ needs.changes.outputs.docs == 'true' || needs.changes.outputs.code == 'true' }} | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.12" | |
| - name: Install pyyaml | |
| run: pip install pyyaml | |
| - name: Validate anomaly registry | |
| run: python scripts/check_anomalies.py | |
| - name: Check bibliography citations | |
| run: python scripts/check_citations.py | |
| # ── Tests (only on code changes) ─────────────────────────────────────── | |
| test: | |
| needs: changes | |
| if: ${{ needs.changes.outputs.code == 'true' }} | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| python-version: ["3.10", "3.11", "3.12"] | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Checkout MADDENING | |
| uses: actions/checkout@v4 | |
| with: | |
| repository: Microrobotics-Simulation-Framework/MADDENING | |
| path: _maddening | |
| token: ${{ secrets.MADDENING_TOKEN }} | |
| - name: Set up Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install "jax==0.5.1" "jaxlib==0.5.1" | |
| pip install -e _maddening | |
| pip install -e ".[ci]" | |
| - name: Run tests (skip slow benchmarks) | |
| env: | |
| JAX_PLATFORMS: cpu | |
| XLA_FLAGS: "--xla_gpu_autotune_level=0" | |
| PYTEST_DISABLE_PLUGIN_AUTOLOAD: "1" | |
| run: python -m pytest tests/ -v --tb=short -m "not slow" | |
| - name: Check implementation mapping | |
| run: python scripts/check_impl_mapping.py |