Skip to content
Deploy Sphinx docs

Update build-docs.yml #5

Sign in to view logs

Update build-docs.yml

Update build-docs.yml #5

Workflow file for this run

.github/workflows/build-docs.yml at 8588e22
name: Deploy Sphinx docs
on: [push, pull_request, workflow_dispatch]
permissions:
contents: write
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v3
- name: Install dependencies
run: |
pip install sphinx sphinx_rtd_theme furo sphinx_copybutton docutils sphinx_inline_tabs sphinx_removed_in
- name: Sphinx build
run: |
sphinx-build -b html docs/source/ docs/build/html
- 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