Docs and docs build update #17
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
|
Okay, this seems to have repaired the build. Before merging I want to |
This should resolve an issue with Read the Docs builds where Python API and CLI pages were not built - inspection of RtD build logs showed that build_manpage & autosummary had ImportErrors converted to warnings. RtD build used Python 3.7. Using Python 3.9 for building docs seems to be a sensible choice, if only because that's the current version in debian stable (although minimal requirement for the extension is 3.8). Our docs build relies on having our package installed. This apparently happened by default with no RtD config, but now this has to be made explicit in the config file.
This adds pip installation instructions ("bleeding edge" git+https)
and reorganizes badges to separate docs from CI.
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.
This should resolve an issue with Read the Docs builds where Python
API and CLI pages were not built - inspection of RtD build logs showed
that build_manpage & autosummary had ImportErrors, which were
converted to a warning. RtD build used Python 3.7.
Going up to Python 3.9 seems to be a sensible choice because that's
the current version in debian stable (although minimal requirement for
the extension is 3.8).
Important note: our docs build relies on having this package
installed. This apparently happened by default previously, but now
that we use the
.readthedocs.yamlfile, we have to state itexplicitly: