Update README.rst #141
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 | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| # Checkout and build the docs with sphinx | |
| - uses: actions/checkout@v2 | |
| - name: Build HTML | |
| uses: ammaraskar/sphinx-action@master | |
| with: | |
| docs-folder: "docs/" | |
| # pre-build-command: "mkdir /tmp/sphinx-log" | |
| - name: Upload artifacts | |
| uses: actions/upload-artifact@v1 | |
| with: | |
| name: html-docs | |
| path: docs/build/html/ | |
| # Deploys to the gh-pages branch if the commit was made to master, the | |
| # gh-pages then takes over serving the html | |
| - name: Deploy | |
| uses: peaceiris/actions-gh-pages@v3 | |
| if: github.ref == 'refs/heads/main' | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: docs/build/html |