Skip to content

Finish filling in all of the API docs (#165) #56

Finish filling in all of the API docs (#165)

Finish filling in all of the API docs (#165) #56

Workflow file for this run

name: Documentation
permissions:
contents: read
pages: write
id-token: write
on: [push, pull_request]
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v3
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: '3.10'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install sphinx
pip install -r docs/requirements.txt
- name: Build Sphinx Documentation
run: |
cd docs
make api html
- name: Upload Pages Artifact
uses: actions/upload-pages-artifact@v1
with:
path: docs/_build/html
deploy:
if: github.ref == 'refs/heads/master'
needs: build
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deploy-pages.outputs.page_url }}
steps:
- name: Deploy to GitHub Pages
uses: actions/deploy-pages@v1