I have a package roughly like this:
my_package/
__init__.py
private.py
My documentation is inline with the code thanks to Sphinx's autodoc extension.
private.py contains private code, but defines a dependent class which
is part of my package's external interface.
I expose this class via __init__.py, which comprises my package's
external interface.
# __init__.py:
from my_package.private import PublicClass
I don't want my package's users to have to deal with the
implementation details of private.py, so I wish to have the generated
docs act like PublicClass is defined in the toplevel module/package
itself (i.e. address it as my_package.PublicClass, rather than
my_package.private.PublicClass).
How do I get Sphinx [autodoc] to "lie" about PublicClass's location like this?
Thanks,
Chris
--
http://blog.rebertia.com
--
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.
