Skip to content

Commit

Permalink
Static checks for html documentation
Browse files Browse the repository at this point in the history
This commit introduces the static checks for avocado documentation. This
change will help us avoid documentation issues in the future. It makes
the readthedocs build more strict, which make it fail on any warning.

Reference: avocado-framework#5757
Signed-off-by: Jan Richter <[email protected]>
  • Loading branch information
richtja committed Dec 7, 2023
1 parent 65bfbce commit b5008fc
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ build:
# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: docs/source/conf.py
fail_on_warning: true

# We recommend specifying your dependencies to enable reproducible builds:
# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
Expand Down

0 comments on commit b5008fc

Please sign in to comment.