Skip to content

update documentation directory #8

update documentation directory

update documentation directory #8

name: "Sphinx: Render docs"
on: push
jobs:
build:
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- uses: actions/checkout@v4
- name: Install sphinx and build documentation with sphinx
run: |
pip install sphinx sphinx-multiversion sphinx_rtd_theme sphinxcontrib-email
- name: Build HTML
uses: ammaraskar/sphinx-action@master
with:
docs-folder: "docs/"
- name: Upload artifacts
uses: actions/upload-artifact@v4
with:
name: html-docs
path: docs/build/html/
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
if: github.ref == 'refs/heads/main'
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/build/html