Fix sphinx warnings and turn warnings into errors #3290
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
NicolasHug
commented
Jan 25, 2021
.circleci/config.yml
Outdated
| @@ -731,7 +731,7 @@ jobs: | |||
| conda activate ./env | |||
| pushd docs | |||
| pip install -r requirements.txt | |||
| make html | |||
| make html -SPHINXOPTS="-W" | |||
There was a problem hiding this comment.
Maybe a better way would be to set
SPHINXOPTS = -W in doc/Makefile so that contributors would also see the errors when they run make html locally?
Or we can just tell them to compile the docs by running make html SPHINXOPTS="-W" in the relevant contributing guidelines
There was a problem hiding this comment.
Thoughts on this @datumbox ? (It's marked as outdated but it's still relevant)
There was a problem hiding this comment.
I don't mind either, it's your call.
datumbox
reviewed
Jan 25, 2021
datumbox
approved these changes
Jan 26, 2021
facebook-github-bot
pushed a commit
that referenced
this pull request
Feb 1, 2021
Summary: Co-authored-by: Vasilis Vryniotis <datumbox@users.noreply.github.com> Reviewed By: datumbox Differential Revision: D26156360 fbshipit-source-id: 001ecf0ae755140d8dca59f30e5940caf78484a4
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Addresses part 1 of #3003 (comment)
This PR fixes sphinx warnings and sets the
for sphinx to issue warnings when the wrong parameter syntax is used.
The warnings are now turned into errors. Note: sphinx will now stop compilation at the first warning/error it sees; if we relied on sphinx>=8, we could use the
--keep-goingoption to let it finish.