Merge pull request #80 from LewisResearchGroup/feature/jupyter-gui-im… #398
Workflow file for this run
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: Create Documentation | |
| on: | |
| push: | |
| branches: | |
| - develop | |
| - docs/mkdocs | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: 3.12 | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| # Install your package to ensure autodoc works | |
| - name: Upgrade pip | |
| run: python -m pip install --upgrade pip | |
| - name: Install package with docs dependencies | |
| run: python -m pip install -e ".[docs]" | |
| # Build the MkDocs documentation | |
| - name: Build Documentation | |
| run: | | |
| mkdocs build --clean | |
| # Deploy the built documentation to the gh-pages branch | |
| - name: Deploy to GitHub Pages | |
| uses: peaceiris/actions-gh-pages@v3 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: site # MkDocs builds to the 'site' directory by default |