Hi there,

To be able to put more doc in code, I've developped a new simple
autodoc directive which basically add
a module docstring without anything else (eg no module 'signature', no
members).

This was quite easy, though to make it works properly, I had to monkey
patch AutoDirective.run method,
to turn the end of the method into:

    if self.name in ('automodule', 'autodostring'): # XXX add my
custom directive name here
        node = nodes.section()
        # necessary so that the child nodes get the right source/line
set
        node.document = self.state.document
        nested_parse_with_titles(self.state, self.result, node)
    else:
        node = nodes.paragraph()
        node.document = self.state.document
        self.state.nested_parse(self.result, 0, node)

That could be avoid by putting this behaviour on the documenter
classes. Is it fine by you if I submit a patch for that?

Beside this, I can contribute my 'autodocstring' directive if you
think it can be of some general interest.

Thanks,

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-dev" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to 
[email protected].
For more options, visit this group at 
http://groups.google.com/group/sphinx-dev?hl=en.

Reply via email to