Assuming I have a file example.py with the following contents:
class Body(object):
"""Representation of a geometric body."""
def __init__(self):
self.surface = Surface(self)
class Surface(object):
"""Representation of a geometric surface."""
def __init__(self, body):
self.body = body
def get_surface_area(self):
""" Calculate surface area of the body """
print 4
mybody = Body()
mybody.surface.get_surface_area()
When I do
.. automodule:: example
:members:
I get all the two classes and the function documented. However, how would I
go about pointing out the intended usage of my class, i.e.
mybody.surface.get_surface_area()
and also have the correct links in place? Thank you
--
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 [email protected].
To post to this group, send email to [email protected].
Visit this group at http://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.
