27 lines
748 B
YAML
27 lines
748 B
YAML
name: documentation
|
|
|
|
on: [push, pull_request, workflow_dispatch]
|
|
|
|
permissions:
|
|
contents: write
|
|
|
|
jobs:
|
|
docs:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
- uses: actions/setup-python@v3
|
|
- name: Install dependencies
|
|
run: |
|
|
pip install sphinx sphinx_rtd_theme myst_parser
|
|
- name: Sphinx build
|
|
run: |
|
|
sphinx-build -M html . docs
|
|
- 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 |