How would I get, either via autodoc or even *not* autodoc, the
__eq__() method below to appear in documentation?
class SomeFoo(object):
class SomeBar(object):
def __eq__(self, other):
"""Compare a frobnozzle to other."""
SomeBar will be autodocumented from a directive such as below:
.. autoclass:: mypackage:SomeFoo
:members:
:show-inheritance:
However, there's no way to add any kind of :members: directive for
SomeBar, nor is there even a way to include __eq__ explciitly:
.. autoclass:: mypackage:SomeFoo
:members:
:show-inheritance:
.. autoclass:: mypackage.SomeFoo.SomeBar
.. method:: __eq__
because autoclass can't handle it:
autodoc can't import/find class 'mypackage.SomeFoo.SomeBar', it
reported error: "No module named SomeFoo", please check your spelling
and sys.path
I can see .. autoclass:: not understanding traversal into classes
(would be nice if that could be supported someday), but it *does* do
it selectively - it generates the nested class as a member. But
leaves no way at all to control documentation of the nested class.
Ideally the whole system here would support arbitrary nesting. But
for the moment, I'm really hoping to not put the entire mass of
docstrings for my "SomeBar" directly in the .rst file just so this
one method can be rendered.
--
You received this message because you are subscribed to the Google Groups
"sphinx-dev" group.
To post to this group, send email to sphinx-dev@googlegroups.com.
To unsubscribe from this group, send email to
sphinx-dev+unsubscr...@googlegroups.com.
For more options, visit this group at
http://groups.google.com/group/sphinx-dev?hl=en.
