On 2013-06-06, Kristin Barber wrote:

> [-- Type: text/plain, Encoding:  --]

> Hello,

> Can Sphinx handle headings in docstrings for auto-generation?

> Attempting to use a section heading in a docstring gives me this error:

> SEVERE: Unexpected section title.

Can you post a minimal example (non-working docstring), please?

Generally, section headings are only allowed as "first level" elements,
i.e. not inside directives, block quotes, or any other block-level element.
http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#sections

Günter

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to [email protected].
To post to this group, send email to [email protected].
Visit this group at http://groups.google.com/group/sphinx-users?hl=en.
For more options, visit https://groups.google.com/groups/opt_out.


Reply via email to