This repository was archived by the owner on Aug 7, 2024. It is now read-only.
Update README.rst #16
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: Pages | |
| on: | |
| push: | |
| branches: | |
| - master | |
| pull_request: | |
| types: | |
| - opened | |
| branches: | |
| - master | |
| jobs: | |
| pages: | |
| name: Build GitHub Pages | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v2 | |
| - name: Build docs | |
| run: | | |
| python3 -m pip install -U pip | |
| python3 -m pip install -U setuptools wheel | |
| python3 -m pip install .[dev] | |
| python3 -m sphinx -W -b html docs built_html_docs/ | |
| echo ${{ github.ref }} | |
| - name: Deploy to GitHub Pages | |
| if: ${{ github.ref == 'refs/heads/master' }} | |
| uses: crazy-max/ghaction-github-pages@v2 | |
| with: | |
| target_branch: gh-pages | |
| build_dir: built_html_docs | |
| jekyll: false | |
| verbose: true | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} |