Skip to content

Some fixes and tidy-up of main documentation page. (#27) #13

Some fixes and tidy-up of main documentation page. (#27)

Some fixes and tidy-up of main documentation page. (#27) #13

Workflow file for this run

name: "Build/Deploy Docs"
on:
workflow_dispatch:
push:
branches:
- main
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Set up Python 3.11
uses: actions/setup-python@v5
with:
python-version: '3.11'
- name: Install dependencies and local packages
run: python -m pip install sphinx pydata-sphinx-theme
- name: Build HTML documentation with Sphinx
run: |
make html
make html SPHINXOPTS="-W --keep-going -n"
working-directory: docs
- uses: actions/upload-pages-artifact@v3
with:
path: docs/build/html
retention-days: 7
deploy:
# Add a dependency to the build job
needs: build
# Grant GITHUB_TOKEN the permissions required to make a Pages deployment
permissions:
pages: write # to deploy to Pages
id-token: write # to verify the deployment originates from an appropriate source
# Deploy to the github-pages environment
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
# Specify runner + deployment step
runs-on: ubuntu-latest
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4