Skip to content
Deploy Sphinx Docs to GitHub Pages

Hopefully working documentation now try 6 #6

Sign in to view logs

Hopefully working documentation now try 6

Hopefully working documentation now try 6 #6

Workflow file for this run

.github/workflows/generate-documentation.yaml at fead47b
name: Deploy Sphinx Docs to GitHub Pages
on:
push:
branches: [main] # Trigger on pushes to main branch
jobs:
build-and-deploy:
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.11' # Use your Python version
- name: Install dependencies
run: |
python3 -m pip install --upgrade pip
python3 -m pip install sphinx sphinx-rtd-theme sphinxcontrib-napoleon
python3 -m pip install lxml pandas aniso8601
- name: Build Sphinx docs
run: |
cd docs
make html # Builds to docs/build/html
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/build/html # Deploy the built HTML
publish_branch: gh-pages # Target branch for Pages