-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Build the documentation in an action
- Loading branch information
Showing
1 changed file
with
45 additions
and
0 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
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.10' | ||
cache: "pip" | ||
cache-dependency-path: "setup.cfg" | ||
|
||
- name: Install sqlite | ||
run: sudo apt-get install sqlite libyaml-dev | ||
|
||
- 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,<0.9' | ||
|
||
- name: Build documentation | ||
working-directory: ./doc | ||
run: package-docs build -n -W |