[docs] [issue16568] allow constructors to be documented separately from class

Éric Araujo report at bugs.python.org
Thu Nov 29 05:07:36 CET 2012


Éric Araujo added the comment:

For all the built-in types, I see the value now.

Thinking aloud: Separating the namespaces used by the str and func roles would probably require too many changes in Sphinx.

The current way is to use the function directive to document the class/constructor usage in one place, and use ref to link to the section describing the class.  You can also have the cool class/method combo if you configure the class directive with the noindex option.  Is that not good enough?

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue16568>
_______________________________________


More information about the docs mailing list