Skip to content

Commit

Permalink
Add a GitHub action reponsible for building docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mxk62 committed Feb 2, 2024
1 parent c3b691a commit 4928717
Showing 1 changed file with 42 additions and 0 deletions.
42 changes: 42 additions & 0 deletions .github/workflows/build_docs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
name: docs

on:
push:
branches:
- main
pull_request:

jobs:
build_sphinx_docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
with:
# Need to clone everything for the git tags.
fetch-depth: 0

- name: Set up Python
uses: actions/setup-python@v3
with:
python-version: '3.11'
cache: "pip"
cache-dependency-path: "setup.cfg"

- name: Update pip/wheel infrastructure
run: |
python -m pip install --upgrade pip
pip install wheel
- name: Install dependencies
run: |
pip install -r requirements.txt
- name: Build and install
run: pip install --no-deps -v .

- name: Install documenteer
run: pip install 'documenteer[pipelines]==0.8.2'

- name: Build documentation
working-directory: ./doc
run: package-docs build -n

0 comments on commit 4928717

Please sign in to comment.