Merge branch 'develop' #33
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: Build and Deploy Documentation using Sphinx | |
| on: | |
| branches: | |
| - main # You can change this to match your default branch | |
| workflow_dispatch: | |
| jobs: | |
| docsbuild: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v3 | |
| - name: Set up Python 3.10 | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: "3.10" | |
| - uses: actions/cache@v2 | |
| with: | |
| path: | | |
| ~/.cache/pip | |
| key: ${{ runner.os }}-${{ hashFiles('**/make.bat') }} | |
| restore-keys: | | |
| {{ runner.os }}-pip- | |
| - name: Install Dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| python -m pip install '.[Dev]' | |
| - name: Build with Sphinx | |
| run: | | |
| sphinx-build -E -b html ./docsrc ./docs | |
| - name: Deploy to GH-Pages | |
| if: always() | |
| uses: peaceiris/actions-gh-pages@v3 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: ./docs |