Consider the module below.
sphinxtest.py:
"""A module to test Sphinx.
.. autoclass:: _Foo
:members:
:private-members:
"""
import enum
class _Foo(object):
"""A class to test Sphinx.
:param name: The name of the Foo.
:type name: str
"""
def __init__(self, name):
self.__name = name
# Name will be mangled to _Foo__Bar
class __Bar(enum.Enum):
"""A private inner class."""
BAZ = 1
"""Bar gonna baz."""
How can I get the __Bar inner class (whose name will be mangled to
_Foo__Bar) to be automatically documented? (I.e. the docstrings of both
the inner class and its member should be included in the generated
documentation.)
Currently, the generated documentation only includes this.
_Foo__Bar
alias of sphinxtest._Foo.__Bar
I have tried adding and additional autoclass directive to the module
docstring, but everything that I've tried has given me an error.
How am I supposed to do this?
--
========================================================================
Google Where SkyNet meets Idiocracy
========================================================================
--
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 sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit
https://groups.google.com/d/msgid/sphinx-users/trrea1%24fg0%241%40ciao.gmane.io.
