Skip to content

Commit

Permalink
Make document generation job more strict (#463)
Browse files Browse the repository at this point in the history
Right now, the documentation generator job does not fail when there
is a warning. We wanted to fail on such warnings because the warning
shown might result in missing content on the generated docs.

We achieve this by supplying the `-W` SPHINXOPTS. Also, we provide
`--keep-going` to not just fail on the first warnings we see
and try to keep going. This way, we would see all warnings. Note that,
the exit code will still be non-zero if there are some warnings and
the job will fail.
  • Loading branch information
mdumandag committed Sep 3, 2021
1 parent e164174 commit 9567289
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion .github/workflows/test_runner.yml
Original file line number Diff line number Diff line change
Expand Up @@ -83,4 +83,4 @@ jobs:
- name: Generate documentation
working-directory: docs
run: |
make html
make html SPHINXOPTS="-W --keep-going"

0 comments on commit 9567289

Please sign in to comment.