Improve doc build; fix Read the Docs config #560
Merged
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.
Our Read the Docs build is currently failing. The proximate cause is that I removed the
docs
optional requirements when things got migrated topyproject.toml
, but I suspect that even with that fixed other things would have gone wrong.This PR reworks the doc build a bit to make it more Read-the-Docs friendly:
sphinx-build -b html
step to build the docs; the api documentation generation is taken care of for us. This ensures that the API docs will be included in the Read the Docs build.docs/requirements.txt
, and pin versions. (Without this, RtD will use Sphinx 1.8.6. See https://docs.readthedocs.io/en/stable/build-default-versions.html#external-dependencies for more info.)etstool.py
for the above changes.Test build on RtD: https://readthedocs.org/projects/envisage/builds/19891791/