astropy / sphinx-automodapi

Sphinx extension for generating API documentation
https://sphinx-automodapi.readthedocs.io
BSD 3-Clause "New" or "Revised" License
65 stars 45 forks source link

Add automodsumm_included_members option #103

Closed lukelbd closed 1 year ago

lukelbd commented 4 years ago

Implements item 2 from #91. This adds and documents the automodsumm_included_members option, which is used to add private methods other than __init__ and __call__ to the online documentation. This is useful when creating array-like or dict-like classes, for which it would be useful to document special class methods like __setitem__ and __getitem__.

codecov[bot] commented 4 years ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 87.19%. Comparing base (4c8e33c) to head (8e59794). Report is 141 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #103 +/- ## ======================================= Coverage 87.19% 87.19% ======================================= Files 5 5 Lines 695 695 ======================================= Hits 606 606 Misses 89 89 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

astrofrog commented 4 years ago

Looks good, could you rebase this, and add a test? Thanks!

bsipocz commented 1 year ago

This was opened from an org's fork to which maintainers can't push updates. Given the inactivity for the rebase and add test comment above, I'll go ahead and open a separate PR with 1) rebasing the commit from here, 2) cherry-pick and fixup the test from the commit mentioned in the comment above.

bsipocz commented 1 year ago

superseded by #165