Of course, thank you for the response!
Here is a minimal exmaple:
class Instruction:
"""
Instruction
===========
This is a container class for information about an instruction.
"""
def __init__(self, mnemonic, opcode, address, disassembly, parent):
self.mnemonic = mnemonic
self.opcode = opcode
self.address = address
self.disassembly = disassembly
self.coverage = {}
self.parentSegment = parent
I would like for there to be a section heading for each individual class
within a module -- but this gives the error that I mentioned before.
Perhaps I am using the section headings incorrectly, although it seems this
should work. Any feedback is appreciated.
Kristin
On Friday, June 7, 2013 2:06:01 AM UTC-5, Guenter Milde wrote:
>
> 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.
