-
Notifications
You must be signed in to change notification settings - Fork 164
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
23 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,23 @@ | ||
name: Check autogenerated docs and build the documentation | ||
|
||
on: push | ||
|
||
jobs: | ||
chech-autogenerated-docs: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v3 | ||
- name: Remove the auto generated documentation source files | ||
run: make -C docs cleanall | ||
- name: Regenerate the autogenerated files | ||
# run "true" instead of sphinx-build to speed things up | ||
run: make -C docs html SPHINXBUILD=true | ||
- name: Check that the generated docs where already commited | ||
run: git diff --exit-code | ||
|
||
build-docs: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v3 | ||
- name: Build the documentation | ||
run: make -C docs html |