Raise RTD doc build warnings as errors (#1823)

* suppress epub warn * fail on warn * suppress epub warn * fail on warn * disable epub * typo * remove obsolete suppress
2020-05-22 02:30:40 +02:00 · 2020-05-22 02:30:40 +02:00 · 868dde2223
parent 98f7842970
commit 868dde2223
1 changed files with 4 additions and 3 deletions
--- a/.readthedocs.yml
+++ b/.readthedocs.yml
@ -9,15 +9,16 @@ version: 2
 # reference: https://docs.readthedocs.io/en/stable/config-file/v2.html#sphinx
 sphinx:
  configuration: docs/source/conf.py
-  # TODO: set it true and debug failing
-  fail_on_warning: false
+  fail_on_warning: true

 # Build documentation with MkDocs
 #mkdocs:
 #  configuration: mkdocs.yml

 # Optionally build your docs in additional formats such as PDF and ePub
-formats: all
+formats:
+  - htmlzip
+  - pdf

 # Optionally set the version of Python and requirements required to build your docs
 python: