Version updated to 1.0.0 #23
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: Publish Documentation | |
| on: | |
| push: | |
| branches: | |
| - main | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout Repository | |
| uses: actions/checkout@v4 | |
| - name: Setup Python | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: "3.11" | |
| - name: Install Poetry | |
| uses: snok/install-poetry@v1 | |
| with: | |
| virtualenvs-create: true | |
| virtualenvs-in-project: true | |
| installer-parallel: true | |
| - name: Load cached venv | |
| id: cached-poetry-dependencies | |
| uses: actions/cache@v3 | |
| with: | |
| path: .venv | |
| key: docs-venv-${{ runner.os }}-${{ hashFiles('poetry.lock') }} | |
| - name: Install Dependencies | |
| if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true' | |
| run: poetry install -E docs --no-interaction --no-root | |
| - name: Build Documentation | |
| run: poetry run sphinx-build -b html docs docs/_build/html | |
| - name: Deploy documentation. | |
| if: ${{ github.event_name == 'push' }} | |
| uses: JamesIves/[email protected] | |
| with: | |
| branch: gh-pages | |
| force: true | |
| folder: docs/_build/html |