Build docs with warnings as errors #882
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
|
Unlike locally this fails on travis. Probably due to a much older version of pandoc |
|
So now (post e8367b9) this PR is rather a cleanup up the docs build process than an enforcing that there are no warnings? |
|
@WilliamHPNielsen not really post that it's an attempt to find a way to fix the warnings before flipping the switch back again 😃 |
This reverts commit e8367b9.
|
Which I think it does now 🤞 |
|
Awesome! |
WilliamHPNielsen
approved these changes
Nov 24, 2017
| @@ -24,6 +24,9 @@ install: | |||
| - pip install -r requirements.txt | |||
| - pip install -r test_requirements.txt --upgrade | |||
| - pip install -r docs_requirements.txt | |||
| # Install a new version of Sphinx that correctly handles forward refs once 1.7.0 is out that should | |||
| # be used instead | |||
| - pip install git+https://github.com/jenshnielsen/sphinx.git@working_forward_ref --upgrade | |||
There was a problem hiding this comment.
No it's not great. The alternative is to wait for 1.7.0 to be released
|
@jenshnielsen I think we can merge it. Or would you prefer to wait for the next sphinx release? |
|
Lets merge I would say |
|
Once this is merged we need to be extra careful that all branches are up to date with master before merging to not break master |
giulioungaretti
pushed a commit
that referenced
this pull request
Dec 6, 2017
Author: Jens Hedegaard Nielsen <jenshnielsen@gmail.com>
Build docs with warnings as errors (#882)
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.
Prevent Sphinx syntax errors to creep into the docs and fix all remaining warnings
Also
Add missing .PHONY to makefile
@WilliamHPNielsen