This repository was archived by the owner on Oct 15, 2025. It is now read-only.
Update README.md #12
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: Documentation | |
| on: | |
| push: | |
| branches: | |
| - master | |
| jobs: | |
| docs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v1 | |
| - name: Set up Python | |
| uses: actions/setup-python@v1 | |
| with: | |
| python-version: 3.7 | |
| - name: Install Dependencies | |
| run: | | |
| pip install --upgrade pip | |
| pip install .[dev] | |
| - name: Generate Docs | |
| run: | | |
| make gen-docs | |
| touch docs/_build/html/.nojekyll | |
| - name: Publish Docs | |
| uses: JamesIves/github-pages-deploy-action@releases/v3 | |
| with: | |
| ACCESS_TOKEN: ${{ secrets.ACCESS_TOKEN }} | |
| BASE_BRANCH: master # The branch the action should deploy from. | |
| BRANCH: gh-pages # The branch the action should deploy to. | |
| FOLDER: docs/_build/html/ # The folder the action should deploy. | |