Skip to content

Raise RTD doc build warnings as errors #1823

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
May 22, 2020
Merged

Raise RTD doc build warnings as errors #1823

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
d16a3e1
suppress epub warn
awaelchli May 13, 2020
a6ffdcd
fail on warn
awaelchli May 13, 2020
61f5f4c
suppress epub warn
awaelchli May 13, 2020
2c78616
fail on warn
awaelchli May 13, 2020
905db6e
Merge remote-tracking branch 'PyTorchLightning/docs/RTD-warn-as-error…
awaelchli May 14, 2020
29118dd
disable epub
awaelchli May 14, 2020
713a50c
typo
awaelchli May 14, 2020
481ec2d
remove obsolete suppress
awaelchli May 14, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions .readthedocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down