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.

Sign up for GitHub

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

Jump to bottom

Close #5923: autodoc: allow not to document inherited members of specific super class #6873

Merged
merged 2 commits into from Dec 22, 2019
Merged

Close #5923: autodoc: allow not to document inherited members of specific super class #6873

merged 2 commits into from Dec 22, 2019

Conversation

tk0miya
Copy link
Member

@tk0miya tk0miya commented Nov 30, 2019

@tk0miya tk0miya added type:enhancement enhance or introduce a new feature extensions:autodoc labels Nov 30, 2019
@tk0miya tk0miya added this to the 3.0.0 milestone Nov 30, 2019
@tk0miya tk0miya mentioned this pull request Nov 30, 2019
Closed
@tk0miya tk0miya force-pushed the 5923_autodoc_inherited_members_can_ignore_specific_superclass branch from 5f6c571 to 7c79a6b Compare December 1, 2019 03:51
@codecov
Copy link

codecov bot commented Dec 1, 2019 •
edited

Codecov Report

Merging #6873 into master will increase coverage by 0.01%.
The diff coverage is 88.23%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #6873      +/-   ##
==========================================
+ Coverage   84.45%   84.46%   +0.01%     
==========================================
  Files         267      266       -1     
  Lines       40682    40688       +6     
  Branches     5959     5965       +6     
==========================================
+ Hits        34357    34367      +10     
+ Misses       5015     5013       -2     
+ Partials     1310     1308       -2
Impacted Files Coverage Δ
tests/test_autodoc.py 96.88% <100%> (+0.07%) ⬆️
sphinx/ext/autodoc/__init__.py 89.25% <83.33%> (ø) ⬆️
sphinx/__init__.py

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 9d39b18...a209002. Read the comment docs.

shimizukawa
shimizukawa approved these changes Dec 22, 2019
View reviewed changes
Copy link
Member

@shimizukawa shimizukawa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM with a suggestion.

doc/usage/extensions/autodoc.rst Show resolved Hide resolved
@tk0miya tk0miya merged commit e83bb29 into sphinx-doc:master Dec 22, 2019
@tk0miya
Copy link
Member Author

tk0miya commented Dec 22, 2019

Merged.
@shimizukawa Thank you for reviewing! I'm encouraged by your review :-)

@tk0miya tk0miya deleted the 5923_autodoc_inherited_members_can_ignore_specific_superclass branch December 22, 2019 07:31
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 8, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@shimizukawa shimizukawa shimizukawa approved these changes

Assignees
No one assigned
Labels
extensions:autodoc type:enhancement enhance or introduce a new feature
Projects
None yet
Milestone
3.0.0
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@tk0miya @shimizukawa