I'm trying to use' autodoc_docstring_signature = True' in conf.py, but
it has no effect on documenting my classes implemented using the C
API. I can't seem to find an example...
Here is my C doc string.
PyDoc_STRVAR(propertyDoc,
"BoolProperty(name, label, initValue=False)\n"
"\n"
"Construct a boolean property\n"
"\n"
"Keyword arguments:\n"
" name (str) -- the name of the property\n"
" label (str) -- the label of the property, tyically the label
shown in the GUI\n"
" initValue (bool) -- the the initial value (default False)\n"
);
And here is the resulting Sphinx doc, which does not replace the C
constructor with the signature in the first line of the doc string.
class mymodule.BoolProperty
BoolProperty(name, label, initValue=False)
Construct a boolean property
Keyword arguments:
name (str) – the name of the property label (str) – the label of the
property, tyically the label shown in the GUI initValue (bool) – the
the initial value (default False)
Any ideas why it doesn't work?
--
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.
