Skip to content

Issue #17: Sphinx documentation #4

Issue #17: Sphinx documentation

Issue #17: Sphinx documentation #4

Workflow file for this run

name: Build Documentation
on: [pull_request]
permissions:
contents: write
jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v3
with:
python-version: '3.10'
- name: Install dependencies
run: |
pip install -e .
- name: Sphinx build
run: |
cd docs
make html
# - name: Deploy to GitHub Pages
# uses: peaceiris/actions-gh-pages@v3
# # if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
# with:
# publish_branch: gh-pages
# github_token: ${{ secrets.GITHUB_TOKEN }}
# publish_dir: _build/
# force_orphan: true