Fix trait_documenter to be less fragile #1247
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
mdickinson
commented
Jul 20, 2020
mdickinson
commented
Jul 20, 2020
rahulporuri
approved these changes
Jul 22, 2020
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 PR modifies trait_documenter to be less fragile when a trait definition can't be found.
Previously, a failure to find a trait definition would raise
StopIterationand cause the entire documentation build to be aborted. With the changes in this PR, that failure will instead issue a warning, and the documentation build will continue.The PR also includes some refactoring to make it easier to add unit tests: in particular, the
_get_trait_definitionmethod, which depended on hard-to-set-up objects like theClassLevelDocumenter, has had its logic moved into a standalone functiontrait_definitionthat doesn't need to know anything about Sphinx.This PR fixes the aspect of #1238 that a failed definition retrieval breaks the doc build. It doesn't fix the underlying issue that caused the failed trait definition retrieval in the first place. That part is fixed by #1246. Note that the two PRs will almost certainly conflict, but resolving those conflicts shouldn't be particularly hard.
Also: #1246 should be backported to the release branch, while this PR is less bug-fixy, so should probably not be backported.