I noticed that there are many modules in the current code base that are not listed at: http://matplotlib.sourceforge.net/modindex.html. I understand that a few are new files and that the documentation for these will be generated during the next release. But I know that most of these were in the last release so should have had their documentation generated. Am I missing something? Can the documentation for these modules be found somewhere else?
You’re not missing anything in terms of the html/pdf docs. When we converted our documentation build system to sphinx/rest, we had to convert our docstrings to rest as well. We made good headway for a while but the progress has stalled. To add a module to the documentation system, you need to
make sure the docstrings are ReST compliant
add a stub in doc/api (eg see figure_api.rst
add your new rst file to doc/api/index.rst
We’d like to see all of the user facing modules converted, so contributions are welcome. See also
In the meantime, you can always use pydoc or help from the interactive shell, eg::
pydoc also has flags for generating html, etc.
or from the shell (ipython here)::
In : import matplotlib.patheffects
In : help matplotlib.patheffects
On Mon, Feb 22, 2010 at 1:44 PM, Ben Axelrod <BAxelrod@…2066…> wrote: