Fix doc generation #28
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: doc | |
| on: | |
| # Trigger on push | |
| push: | |
| paths: | |
| # trigger only if we change the doc ... | |
| - 'docs/**' | |
| # ... or if we change the project version | |
| - 'pyproject.toml' | |
| # Trigger only on master branch (avoids updating the doc in a pull request) | |
| branches: | |
| - master | |
| # Trigger manually from the "Actions" tab | |
| workflow_dispatch: | |
| jobs: | |
| deploy: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout sources to build the doc | |
| uses: actions/checkout@v2 | |
| - name: Get python | |
| uses: actions/setup-python@v2 | |
| with: | |
| python-version: '3.x' | |
| - name: Upgrade pip and install poetry | |
| run: | | |
| python3 -m pip install --upgrade pip | |
| pip install poetry | |
| - name: Build the documentation | |
| run: | | |
| poetry install --only=docs | |
| poetry run tox -edocs | |
| - name: Deploy on gh-pages | |
| uses: peaceiris/actions-gh-pages@v3 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: ./docs/_build/html | |
| publish_branch: gh-pages |