Open ideabrian opened 13 years ago
"For this to work, the docstrings must of course be written in correct reStructuredText. You can then use all of the usual Sphinx markup in the docstrings, and it will end up correctly in the documentation. "
http://sphinx.pocoo.org/ext/autodoc.html#module-sphinx.ext.autodoc
The module or the package must be in one of the directories on sys.path – adapt your sys.path in the configuration file accordingly.
autodoc provides several directives that are versions of the usual py:module, py:class
On parsing, they import the corresponding module and extract the docstring of the given objects.
They insert them into the page source under a suitable py:module, py:class etc. directive
I'm on this right now.