Browse Source

Flags added to convert doc build warnings to errors

- To ensure that the CI will fail if there are broken links or images.
- Fixes #9778
Neeraj P Yetheendran 1 year ago
parent
commit
adfd8b32dc
2 changed files with 3 additions and 1 deletions
  1. 2 0
      .readthedocs.yml
  2. 1 1
      docs/Makefile

+ 2 - 0
.readthedocs.yml

@@ -9,3 +9,5 @@ python:
       path: .
       extra_requirements:
         - docs
+sphinx:
+  fail_on_warning: True

+ 1 - 1
docs/Makefile

@@ -2,7 +2,7 @@
 #
 
 # You can set these variables from the command line.
-SPHINXOPTS    =
+SPHINXOPTS    = -W --keep-going -n
 SPHINXBUILD   = sphinx-build
 PAPER         =
 BUILDDIR      = _build