search

Chilipp / autodocsumm

Extending your autodoc API docs with a summary
Apache License 2.0
48 stars 14 forks source link

Remove directive #28

Closed Chilipp closed 4 years ago

Chilipp commented 4 years ago

This PR changes the strategy of autodocsumm. Previously, we manipulated the autoclass and automodule directives to generate nodes that are inserted in the docs (in a more or less random manner, see #21 and #14), now we add the attributes that shall be documented directly via the .. autosummary:: directive. This also resolves the ambiguity of the positioning of the autosummary tables.

closes #21, closes #14

domdfcoding commented 4 years ago

Hi @Chilipp, any chance of having a new release on PyPI with these changes?

Chilipp commented 4 years ago

yep. Will come within this week @domdfcoding . I plan to add a .. autoclasssumm:: and .. automodulesumm:: directive to generate the table upon request (i.e. separate from the current implementation in the .. autoclass:: and .. automodule:: directive). Hopefully I'll find the time to do this within this week, if not, I'll make a new release by the end of the week with the current state.

domdfcoding commented 4 years ago

Wonderful, thanks

Chilipp commented 4 years ago

@domdfcoding: I just made a new release on PyPi, conda-forge will come soon