Build Docs #23
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: Build Docs | |
on: | |
# Trigger on pushes to the main branch only. | |
# See #5 ref restricting to tags. | |
push: | |
branches: [ main ] | |
# Or run manually. | |
workflow_dispatch: | |
jobs: | |
build-and-upload: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v3 | |
- uses: actions/setup-python@v4 | |
with: | |
python-version: '3.x' | |
- name: Install dependencies | |
run: | | |
python -m pip install --upgrade pip | |
pip install Django Sphinx myst-parser furo | |
pip install -e . | |
- name: Build docs | |
run: make json | |
working-directory: ./docs | |
# Refs #22: Upload an artifact containing the built docs. | |
- name: Upload docs | |
uses: actions/upload-artifact@v2 | |
with: | |
# Use a name from the commit hash to avoid collisions. | |
name: docs-${{ github.sha }} | |
path: docs/build/json |