Skip to content

Commit

Permalink
Check and build docs in CI
Browse files Browse the repository at this point in the history
  • Loading branch information
lucc committed Nov 28, 2023
1 parent e47953a commit c530fad
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions .github/workflows/docs.yml
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

0 comments on commit c530fad

Please sign in to comment.