Skip to content
Sphinx: Render docs

Edited example code for docs #8

Sign in to view logs

Edited example code for docs

Edited example code for docs #8

Workflow file for this run

.github/workflows/sitebuild.yml at 1fc0eda
name: "Sphinx: Render docs"
on:
push:
branch: # Only rebuild site if main branch changes
- main
paths: # Only rebuild site if relevant components change.
- '**.rst'
- '**.py'
jobs:
build:
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- uses: actions/checkout@v4
- name: Build HTML
run: |
pip install -r requirements.txt
sphinx-build -M html docs docs/build
- name: Upload artifacts
uses: actions/upload-artifact@v4
with:
name: html-docs
path: docs/build/html/
- name: Deploy
uses: peaceiris/actions-gh-pages@v4
if: github.ref == 'refs/heads/main'
with:
publish_branch: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/build/html