Skip to content

DOC: sphinx documentation + GIT: workflow #1

DOC: sphinx documentation + GIT: workflow

DOC: sphinx documentation + GIT: workflow #1

Workflow file for this run

name: Publish Sphinx Documentation
on:
push:
jobs:
publish_sphinx_docs:
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v3
with:
python-version: "3.10"
- name: Install dependencies
run: |
pip install -e .
pip install sphinx furo
pip install sphinx_mdinclude
pip install sphinx-rtd-theme
- name: Sphinx build
run: |
sphinx-apidoc -o docs src/sphinxy/ --separate
sphinx-build docs docs/_build/html
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
with:
publish_branch: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/_build/html
force_orphan: true