Chilipp / autodocsumm

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

module-level summary location affected by headers in module docstring #21

Closed jbloom closed 4 years ago

jbloom commented 4 years ago

Everything with autodocsumm works great I have a module with a docstring like this:

"""
========
mymodule
========

Here is a summary of module.

"""

When I build the sphinx docs, I get my module level docstring followed by the summary (table of contents) for the module.

But if the module-level docstring looks like this:

"""
=========
mymodule2
=========

Subheading
-------------
Some stuff
"""

then when I build the sphinx docs, the summary (table of contents) appears before the module-level doc string--which looks strange and doesn't really make sense.

Chilipp commented 4 years ago

Hi @jbloom! My apologies for being so silent! I resolved this ambiguity with #28 and it's now always behind the module-level docstring

Chilipp commented 4 years ago

Just a quick update: With #29 you can now also specify the exact positioning of the summary by adding the .. autoclasssumm directive in a class docstring, see https://autodocsumm.readthedocs.io/en/latest/examples.html#positioning-of-the-autosummary-table