On 2013-06-07, Kristin Barber wrote:
> [-- Type: text/plain, Encoding: quoted-printable --]
> 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
> 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.
You indent the docstring content, this seems to put it in a quote, where
headings are not allowed. Does it work if you unindent?
class Instruction:
"""
Instruction
===========
This is a container class for information about an instruction.
"""
def __init__(self, mnemonic, opcode, address, disassembly, parent):
self.mnemonic = mnemonic
...
>> 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.
