Fix #9866: autodoc: doccoment for the imported class was ignored#9876
Merged
tk0miya merged 1 commit intosphinx-doc:4.xfrom Nov 22, 2021
Merged
Conversation
87f0b10 to
eea38ba
Compare
…nored Autodoc tried to scan doccomment on the module where the class defined. But it failed to get it if the class is imported from other module. This analyzes the target module to obtain the doccomment.
eea38ba to
fb92547
Compare
tk0miya
added a commit
to tk0miya/sphinx
that referenced
this pull request
Jan 30, 2022
tk0miya
added a commit
to tk0miya/sphinx
that referenced
this pull request
Jan 30, 2022
tk0miya
added a commit
that referenced
this pull request
Feb 6, 2022
Fix #9876: autodoc: Failed to document a class on binary module
This file contains hidden or 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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
2 participants
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.
Feature or Bugfix
Purpose
But it failed to get it if the class is imported from other module.