Skip to content
Build Sphinx documentation

Build documentation using existing Sphinx setup. #1

Sign in to view logs

Build documentation using existing Sphinx setup.

Build documentation using existing Sphinx setup. #1

Workflow file for this run

.github/workflows/build-docs.yaml at 08c9aae
name: Build Sphinx documentation
on: [push, pull_request]
permissions:
contents: write
jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v3
with:
cache: pip
cache-dependency-path: ./docs/requirements.txt
- name: Install dependencies
run: |
pip install -r docs/requirements.txt
- name: Sphinx build
run: |
sphinx-build docs/source docs/build
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
with:
publish_branch: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/build/html/
force_orphan: true