Skip to content

switch to sphinxawesome-theme #31

switch to sphinxawesome-theme

switch to sphinxawesome-theme #31

Workflow file for this run

name: Build Documentation
on:
push:
branches:
- main
workflow_dispatch: # Allows manual trigger from GitHub UI
# Sets permissions to allow committing back to the repository
permissions:
contents: write
jobs:
build:
runs-on: ubuntu-latest
env:
ACTIONS_STEP_DEBUG: true
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.11'
cache: 'pip'
- name: Install Pandoc
run: |
sudo apt-get update
sudo apt-get install -y pandoc
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -r requirements-docs.txt
- name: Copy notebooks to docs source
run: |
chmod +x copy_notebooks.sh
./copy_notebooks.sh
- name: Build Sphinx documentation
run: |
sphinx-build -b html docs/source docs/build/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