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: Check autogenerated docs and build the documentation | |
on: push | |
jobs: | |
chech-autogenerated-docs: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v3 | |
- name: Set up Python | |
uses: actions/setup-python@v4 | |
- name: Install dependencies | |
run: pip install . | |
- run: pip install sphinx | |
- 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 |