Skip to content
Build and Deploy Documentation

fix: requirements for docs in workflow #2

Sign in to view logs

fix: requirements for docs in workflow

fix: requirements for docs in workflow #2

Workflow file for this run

.github/workflows/documentation.yml at cc1d97f
name: Build and Deploy Documentation
on:
push:
branches:
- main
pull_request:
branches:
- main
workflow_dispatch:
jobs:
build:
name: Build and Deploy Documentation
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: '3.x'
- name: Install dependencies
run: |
pip install sphinx pydata_sphinx_theme sphinx_copybutton sphinx.ext.autodoc sphinx.ext.napoleon sphinx.ext.todo myst_parser sphinx_design
- name: Build documentation
run: |
sphinx-build -b html docs/ docs/build/html
- name: Deploy to GitHub Pages
if: github.ref == 'refs/heads/main'
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/build/html