Closed jbloom closed 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
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
Everything with
autodocsumm
works great I have a module with a docstring like this: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:
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.