Files
scribe/.github/workflows/documentation.yml
T
2023-10-08 19:27:40 +02:00

34 lines
1.0 KiB
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
with:
python-version: 3.8
- name: Install dependencies
run: |
pip install sphinx~=7.2 sphinx_rtd_theme~=1.3.0 myst_parser~=2.0.0
pip install -r requirements.txt
pip install torch==1.11.0+cpu torchvision==0.12.0+cpu torchaudio==0.11.0 --extra-index-url https://download.pytorch.org/whl/cpu
- name: Sphinx build
run: |
sphinx-apidoc -o source scraibe/
sphinx-build -M html source docs
make html
- 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: gh-pages
github_token: ${{ secrets.TOKEN_GH }}
publish_dir: ./docs/html
force_orphan: true