Skip to content

Add GitHub Actions workflow for Docs deployment #1

Add GitHub Actions workflow for Docs deployment

Add GitHub Actions workflow for Docs deployment #1

Workflow file for this run

name: Build and Deploy Docs
on:
push:
branches:
- main
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"
- name: Install dependencies
run: |
pip install sphinx sphinx_rtd_theme
# add more dependencies if needed (e.g., numpydoc, myst_parser)
- name: Build HTML
run: |
cd docs
make html
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/_build/html