Skip to content
Documentation

fix(docs): Adding sphinx-generated documentation and workflow for git… #10

Sign in to view logs

fix(docs): Adding sphinx-generated documentation and workflow for git…

fix(docs): Adding sphinx-generated documentation and workflow for git… #10

Workflow file for this run

.github/workflows/documentation.yml at 8c8fd4c
name: Documentation
on:
push:
branches:
- main
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 furo myst-parser
- name: Sphinx build
run: |
sphinx-build docs/source docs/build
- name: Deploy to GitHub Pages
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
allow_empty_commit: true