Skip to content

Commit

Permalink
Add a ci check for the generated docs
Browse files Browse the repository at this point in the history
We had this check when ci was still run on travis.  The commit
f1bbd00 indicates that such a check is
currently needed.
  • Loading branch information
lucc committed Aug 13, 2024
1 parent 3a5236f commit 8e12fb0
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions .github/workflows/check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -47,3 +47,21 @@ jobs:

- name: Build the ${{ matrix.derivation }} derivation
run: 'nix build --print-build-logs .\#${{ matrix.derivation }}'


generated-docs:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4

- name: Set up Python
uses: actions/setup-python@v5

- name: Regenerate all generated docs
# We run "true" instead of "sphinx-build" to speed things up as we are
# only interested in the regeneration of the docs.
run: make -C docs cleanall html SPHINXBUILD=true

- name: Compare the generated docs with the version committed to git
run: git diff --exit-code

0 comments on commit 8e12fb0

Please sign in to comment.