Documenting data members
Marc 'BlackJack' Rintsch
bj_666 at gmx.net
Sat Jan 8 16:54:20 EST 2005
In <mailman.378.1105218913.22381.python-list at python.org>, Frans Englich
wrote:
> I have a custom module which among others contains a dictionary, acting as a
> "constant". I want to document it, but no matter what I do, it doesn't show
> up in `pydoc`. For example, the following doesn't work:
I'm using epydoc_ for my documentation and there the module level and
class level variables are documented in the module/class docstring with
special markup.
> """
> A dictionary of the namespaces.
> """
> xmlns = {
> ...
> }
Will become:
""" (Module description)
:var xmlns: A dictionary of the namespaces.
"""
Ciao,
Marc 'BlackJack' Rintsch
.. _epydoc: http://epydoc.sourceforge.net/
More information about the Python-list
mailing list