Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix #9866: autodoc: doccoment for the imported class was ignored #9876

Merged
merged 1 commit into from Nov 22, 2021

Conversation

tk0miya
Copy link
Member

@tk0miya tk0miya commented Nov 21, 2021

Feature or Bugfix

  • Bugfix

Purpose

@tk0miya tk0miya added this to the 4.4.0 milestone Nov 21, 2021
@tk0miya tk0miya force-pushed the 9866_doccoment_for_imported_classes branch from 87f0b10 to eea38ba Compare November 21, 2021 09:31
…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.
@tk0miya tk0miya force-pushed the 9866_doccoment_for_imported_classes branch from eea38ba to fb92547 Compare November 21, 2021 09:51
@tk0miya tk0miya merged commit 054276c into sphinx-doc:4.x Nov 22, 2021
@tk0miya tk0miya deleted the 9866_doccoment_for_imported_classes branch November 22, 2021 17:49
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Dec 23, 2021
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
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants