Repository navigation
Unify CLI and SDK study execution and diagnostic reports #2733
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: [main] | |
| paths: | |
| - '**.md' | |
| - 'TNFR_lineas_de_investigacion.txt' | |
| - 'docs/assets/**' | |
| - 'factorization-lab/notebooks/**' | |
| - 'src/tnfr/operators/operator_contracts.py' | |
| - 'tests/scripts/test_documentation.py' | |
| - 'mkdocs.yml' | |
| - 'pyproject.toml' | |
| - '.zenodo.json' | |
| - 'CITATION.cff' | |
| - 'src/tnfr/_version.py' | |
| - 'scripts/check_documentation.py' | |
| - 'scripts/prepare_docs.py' | |
| - 'scripts/verify_internal_references.py' | |
| - '.github/workflows/docs.yml' | |
| pull_request: | |
| branches: [main] | |
| paths: | |
| - '**.md' | |
| - 'TNFR_lineas_de_investigacion.txt' | |
| - 'docs/assets/**' | |
| - 'factorization-lab/notebooks/**' | |
| - 'src/tnfr/operators/operator_contracts.py' | |
| - 'tests/scripts/test_documentation.py' | |
| - 'mkdocs.yml' | |
| - 'pyproject.toml' | |
| - '.zenodo.json' | |
| - 'CITATION.cff' | |
| - 'src/tnfr/_version.py' | |
| - 'scripts/check_documentation.py' | |
| - 'scripts/prepare_docs.py' | |
| - 'scripts/verify_internal_references.py' | |
| - '.github/workflows/docs.yml' | |
| workflow_dispatch: {} | |
| concurrency: | |
| group: documentation-${{ github.ref }} | |
| cancel-in-progress: true | |
| permissions: | |
| contents: write | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v5 | |
| - uses: actions/setup-python@v6 | |
| with: | |
| python-version: '3.11' | |
| cache: pip | |
| - name: Install project and documentation dependencies | |
| run: python -m pip install --upgrade pip && python -m pip install '.[docs]' | |
| - name: Verify documentation sources | |
| run: | | |
| python scripts/verify_internal_references.py --ci | |
| python scripts/check_documentation.py | |
| - name: Build canonical site | |
| run: | | |
| python scripts/prepare_docs.py | |
| python -m mkdocs build --strict | |
| - name: Deploy main documentation | |
| if: github.event_name == 'push' && github.ref == 'refs/heads/main' | |
| uses: peaceiris/actions-gh-pages@v4 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: ./site | |
| publish_branch: gh-pages | |
| force_orphan: true | |
| user_name: github-actions[bot] | |
| user_email: github-actions[bot]@users.noreply.github.com | |
| commit_message: docs publish ${{ github.sha }} |