Fix documentation building on rtfd #46
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
"python setup.py build_sphinx -W" now works. This is now a default command to build html docs. Also renamed makefile target "docs" -> "doc" (as there is the docs/ directory, which conflicts with name "docs").
Also build html docs on Travis CI (quality stage).
|
I don't know why we are using conda for this. Looks like a reasonable solution to me. @wheerd What do you think? |
|
I believe that was because at that time Python 3.6 was not available without Conda. We can definitely give it a try. If it works without Conda it's simpler. |
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.
Latest docs build was broken and you can see that API docs are missing on rtfd page, e.g. this. It seems, conda build doesn't install package itself, hence these import failures.
I don't sure how to fix this with conda (don't use it locally), so I switched RTFD config to use
pip install .[docs]. (Additional setuptools extras was added to track documentation building requirements.) I believe, this should fix the problem - similar solution does work on the diofant, which also usessetuptools_scmto manage versions.Also code quality tests on Travis CI now include building html docs.
If you think it's an acceptable solution, then after merging - please check docs building on the readthedocs this time.