Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
jbloom opened this issue Nov 6, 2019 · 2 comments · Fixed by #28
Closed

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

jbloom opened this issue Nov 6, 2019 · 2 comments · Fixed by #28

Comments

@jbloom
Copy link

jbloom commented Nov 6, 2019

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
Copy link
Owner

Chilipp commented Jul 13, 2020

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
Copy link
Owner

Chilipp commented Aug 21, 2020

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants