Hello all,
Currently, I have my documentation on a per-module basis, using a
centralized documentation directory, i.e. `index.rst', `module1.rst',
etc., using the autodoc extension to parse out docstrings in each
module.
However, I would like to be able to store the ReST pages for each
module in the __init__.py files as docstrings themselves, in order to
keep the documentation uniform throughout the project. Is there
anyway to do this, either with vanilla Sphinx or with extensions, or
would this be something I'd have to write myself?
Example:
module1/__init__.py:
"""
:mod:`module1`
Models models models
=================
.. automodule:: module1
:members:
"""
Thanks,
Andrew
--
You received this message because you are subscribed to the Google Groups
"sphinx-dev" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/sphinx-dev?hl=en.