TODO #316
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, pull_request, workflow_dispatch] | |
| jobs: | |
| build_docs: | |
| name: ✏️ Write | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v5 | |
| - name: Install dependencies | |
| run: | | |
| pip install sphinx sphinxemoji sphinxcontrib-prettyspecialmethods sphinx-toolbox | |
| - name: Sphinx build | |
| working-directory: docs | |
| run: | | |
| make clean html | |
| # - name: Setup Pages | |
| # uses: actions/configure-pages@v3 | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: './docs/_build/html' | |
| upload_docs: | |
| name: 📬 Upload | |
| needs: [build_docs] | |
| runs-on: ubuntu-latest | |
| if: github.ref == 'refs/heads/main' | |
| permissions: | |
| pages: write | |
| id-token: write | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| steps: | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v4 | |
| with: | |
| repo-token: ${{ secrets.GITHUB_TOKEN }} |