Skip to content

Add a github action for documentation building. #1

Add a github action for documentation building.

Add a github action for documentation building. #1

Workflow file for this run

name: "Pull Request Docs Check"
on:
- workflow_dispatch
- pull_request
jobs:
docs:
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
working-directory: docs
- uses: actions/upload-artifact@v4
with:
name: documentation
path: docs/build/html
retention-days: 7