Skip to content

Add autodoc_default_options to inherit docstrings#830

Merged
LucaMarconato merged 2 commits intoscverse:mainfrom
quentinblampey:fix_inheritence_docs
Jan 15, 2025
Merged

Add autodoc_default_options to inherit docstrings#830
LucaMarconato merged 2 commits intoscverse:mainfrom
quentinblampey:fix_inheritence_docs

Conversation

@quentinblampey
Copy link
Contributor

Closes #828

I set the following defaults for the autodoc. The first interesting thing is that 'inherited-members': True fixes #828 because it will now show the inherited docstrings. The second thing is that 'members': True significantly cleans up the docs because I can remove it everywhere else.

autodoc_default_options = {
    'members': True,
    'inherited-members': True,
    'show-inheritance': True,
}

Note that I also removed :undoc-members:, because I don't think we should show methods that are not documented (it adds a lot of unreadable sections). But feel free to add it in the defaults if you prefer to have it @LucaMarconato

@codecov
Copy link

codecov bot commented Jan 15, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.72%. Comparing base (f209018) to head (743535b).
Report is 36 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #830   +/-   ##
=======================================
  Coverage   91.72%   91.72%           
=======================================
  Files          46       46           
  Lines        7166     7166           
=======================================
  Hits         6573     6573           
  Misses        593      593           
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@LucaMarconato LucaMarconato merged commit 4630fa1 into scverse:main Jan 15, 2025
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Image2DModel and Image3DModel docs rendered without text

2 participants