Skip to content
documentation

Modifying github actions for documentation #3

Sign in to view logs

Modifying github actions for documentation

Modifying github actions for documentation #3

Workflow file for this run

.github/workflows/documentation.yml at 2962dfc
name: documentation
on: [push, pull_request, workflow_dispatch]
permissions:
contents: write
jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
- name: Install dependencies
run: |
pip install "sphinx==8.1.3" "sphinx-copybutton==0.5.2" "sphinx-hoverxref==1.4.1" "sphinx-click==6.0.0" sphinx_rtd_theme myst_parser "sphinx-autobuild==2024.10.3"
- name: Sphinx build
run: |
sphinx-build docs/source _build
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
with:
publish_branch: github_pages
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: _build/
force_orphan: true