doc: add initial structure for documentation #12
Workflow file for this run
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: "Sphinx: Render docs" | |
| on: push | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| steps: | |
| - name: Checkout source code | |
| uses: actions/checkout@v3 | |
| - name: Install poetry | |
| run: pipx install poetry | |
| - name: Set up Python 3.12 | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: "3.12" | |
| cache: "poetry" | |
| - name: Install dependencies | |
| run: poetry install --no-interaction --with doc | |
| - name: Build doc | |
| run: poetry run make -C docs html | |
| - name: Upload to GitHub pages | |
| uses: actions/upload-pages-artifact@v2 | |
| # if: github.ref == 'refs/heads/main' | |
| with: | |
| path: docs/_build/html | |
| - name: Deploy to GitHub Pages | |
| # if: github.ref == 'refs/heads/main' | |
| uses: actions/deploy-pages@v2 |