I'm using Sphinx and autodoc to document a Python project (hey, what else),
and run into the following:
For the class below I defined documentation as follows:
.. autoclass:: speqs.views.session.Session
:members:
:special-members:
However, when I generate the documentation, only the docstring for the
class and the special member __weakref__ are included.
Any ideas as to what might be wrong here?
class Session(object):
"""The Session class is a facade for remote access to Session objects
living in a remote service or repository.
This class serves as a facade for accessing Session objects that are
stored in a SpeqS repository. It allows
programmers to code against Session objects hosted in other cages
without having to wrap their calls into pmnc (
Pythomnic3k) calls manually.
The Session interface is implemented as a class that can be
instantiated as often as needed.
For convenience, the module containing the class also instantiates an
instance at load, called theSession. This
instance can be used if only one Session object is needed.
"""
def __init__(self):
pass
def setPmnc(self, pmnc):
pass
def load(self, uuid):
"""Load a session - and return it as an HTML snippet.
Keyword arguments:
| name -- [in, string] Name of session.
| uuid -- [in, uuid] Unique ID of session.
Long description and examples:
This function loads the main page of a session, using either the
name of the session or the uuid to find it
in the repository.
It uses chameleon templates to interpret session templates
"""
pass
def addView(self, id):
"""Add a view to the session
Keyword arguments:
| id -- [in, string] UUID of the View statement
Long description and examples:
This function adds the view identified by id to the session.
"""
pass
def removeView(self, id):
"""Remove a view from the session
Keyword arguments:
| id -- [in, string] UUID of the View statement
Long description and examples:
This function removes the view identified by id to the session.
"""
pass
Cheers,
Angelo
--
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/groups/opt_out.
