Skip to content

Updated docs

Updated docs #5

Workflow file for this run

name: Documentation
on:
push:
branches:
- main # or your default branch
paths:
- "docs/**"
- ".github/workflows/docs.yml"
permissions:
contents: read
pages: write
id-token: write
# Allow only one concurrent deployment
concurrency:
group: "pages"
cancel-in-progress: true
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: "3.10"
cache: pip
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install .[docs]
pip install sphinx sphinx-rtd-theme myst-parser sphinx-copybutton
- name: Build documentation
run: |
cd docs
sphinx-build -b html source build/html
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: docs/build/html
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
if: github.ref == 'refs/heads/main' # only deploy from main branch
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4