Resolve "Documentation is somewhat incomplete" #348
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
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.
Summary
Due to the move to the src-layout in v3.1.4, the remote documentation build via readthedocs doesn't worked well (e.g. https://readthedocs.org/api/v2/build/26976527.txt)
By updating the SYS_PATH before building the documentation via
doc/conf.py, readthedocs is able to find the package again (see logs if this PR: https://readthedocs.org/api/v2/build/27008942.txt).I also reviewed the review deployment of the documentation and everything looked well again.
BTW: This was no problem locally and in CI since in both environments, the package is alreayd installed. This is not the case for the environment where readthedocs builds the documentation.
Closes #347