add sphinx documentation workflow

This commit is contained in:
Jaikinator
2023-10-06 12:07:17 +02:00
parent 24e8321b8c
commit 11da0dfa31
+27
View File
@@ -0,0 +1,27 @@
name: documentation
on: [push, pull_request, workflow_dispatch]
permissions:
contents: write
jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v3
- name: Install dependencies
run: |
pip install sphinx sphinx_rtd_theme myst_parser
- name: Sphinx build
run: |
sphinx-build doc _build
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/sphinx_action' }}
with:
publish_branch: sphinx_action
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: _build/
force_orphan: true