Chilipp / autodocsumm

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

feature: print module/class summary without method descriptions on same page #15

Closed maeddlae closed 5 years ago

maeddlae commented 5 years ago

The idea is that one can use

.. autoclass:: module.Class
    :autosummary:

which prints the class docstring and the autodocsummary. Today, autodocsumm does not print anything, because there are no methods documented. This means, the class methods must be documented somewhere else, maybe in another rst. I don't know if this is possible.

The result would be something like this: http://pandas.pydata.org/pandas-docs/stable/reference/series.html#missing-data-handling

Chilipp commented 5 years ago

Interesting idea, thanks! Yes, this should be easy to include. I'll have a look into it

Chilipp commented 4 years ago

just a quick note: #29 now also adds another possibility to generate this: .. autoclasssumm and .. automodulesumm

See the docs for more information