Add docs (#37) #1
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' | |
| - poetry.lock | |
| - pyproject.toml | |
| - '**.rst' | |
| - '**.md' | |
| jobs: | |
| deploy: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4.2.2 | |
| with: | |
| submodules: 'true' | |
| - name: Install dependencies, build docs and coverage report | |
| run: python3 -m pip install --upgrade pip && python3 -m pip install poetry | |
| - uses: actions/setup-python@v5.3.0 | |
| with: | |
| python-version: '3.10' | |
| cache: 'poetry' | |
| - run: | | |
| python3 -m pip install --upgrade pip && python3 -m pip install poetry | |
| poetry env use '3.10' | |
| source $(poetry env info --path)/bin/activate | |
| poetry install --with docs,test | |
| cd docs && rm -rf source/reference/api && make html | |
| - name: Deploy to Github pages | |
| uses: JamesIves/github-pages-deploy-action@v4.7.2 | |
| with: | |
| branch: github_pages | |
| folder: docs/build/html |