Update intro.rst #83
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: docs | |
| on: | |
| push: | |
| branches: | |
| - main | |
| paths: | |
| - .pre-commit-config.yaml | |
| - .github/workflows/code_checks.yml | |
| - .github/workflows/docs_build.yml | |
| - .github/workflows/docs_deploy.yml | |
| - .github/workflows/integration_tests.yml | |
| - '**.py' | |
| - '**.ipynb' | |
| - '**.html' | |
| - '**.js' | |
| - uv.lock | |
| - pyproject.toml | |
| - '**.rst' | |
| - '**.md' | |
| jobs: | |
| deploy: | |
| runs-on: [self-hosted, db] | |
| steps: | |
| - uses: actions/checkout@v4.2.2 | |
| with: | |
| submodules: 'true' | |
| - name: Install uv | |
| uses: astral-sh/setup-uv@v5 | |
| with: | |
| # Install a specific version of uv. | |
| version: "0.5.21" | |
| enable-cache: true | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version-file: ".python-version" | |
| - name: Install dependencies and build docs | |
| run: | | |
| uv sync --group dev --group docs | |
| source .venv/bin/activate | |
| # pandoc README.md -f markdown -t rst -s -o docs/source/intro.rst | |
| cd docs && rm -rf source/reference/api/_autosummary && make html | |
| cd .. && coverage run -m pytest -m "not integration_test" && coverage xml && coverage report -m | |
| - name: Upload coverage to Codecov | |
| uses: Wandalen/wretry.action@v3.8.0 | |
| with: | |
| action: codecov/codecov-action@v4.0.0 | |
| with: | | |
| token: ${{ secrets.CODECOV_TOKEN }} | |
| file: ./coverage.xml | |
| name: codecov-umbrella | |
| fail_ci_if_error: true | |
| attempt_limit: 5 | |
| attempt_delay: 30000 | |
| - name: Deploy to GitHub Pages | |
| uses: peaceiris/actions-gh-pages@v4 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_branch: github_pages | |
| publish_dir: docs/build/html |