Updated logo #72
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: Deploy Sphinx Docs to GitHub Pages | |
| on: | |
| push: | |
| branches: | |
| - main | |
| jobs: | |
| deploy-docs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v3 | |
| - name: Clean __pycache__ and *.pyc | |
| run: find . -name "__pycache__" -exec rm -r {} + -o -name "*.pyc" -delete | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.12" | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install sphinx sphinx-book-theme sphinx-paramlinks sphinxcontrib-bibtex myst-parser importlib-resources nbsphinx sphinx-copybutton | |
| pip install -e . | |
| - name: Install Pandoc | |
| run: | | |
| sudo apt-get update | |
| sudo apt-get install -y pandoc | |
| - name: List structure | |
| run: | | |
| echo "Current directory structure:" | |
| ls -R | |
| - name: Create _static folder (if missing) | |
| run: mkdir -p docs/_static | |
| - name: Build documentation | |
| run: | | |
| make -C docs clean | |
| make -C docs html | |
| - name: Deploy to GitHub Pages | |
| uses: peaceiris/actions-gh-pages@v3 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: ./docs/_build/html | |
| publish_branch: gh-pages | |
| force_orphan: true |