-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1
Roman wrote:
> I am just starting with Sphinx and I cant understand how I should
> integrate regular documentation with the one, extracted from the
> source code?
In your conf.py, have this:
extensions = ['sphinx.ext.autodoc']
To document a module, create a .rst file with this as an example
database.rst.
Database code
=============
.. automodule:: database
:members:
:undoc-members:
You could add more modules to that one file. In your index.rst add the
rst filenames without the rst extension.
Contents:
.. toctree::
:maxdepth: 2
gui
database
podcast
util
test
Roger
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.9 (GNU/Linux)
iEYEARECAAYFAkl/+AUACgkQmOOfHg372QTSvwCgyxhJSe8WH4gX1YYhO53yu2ux
9VIAnjcfpCsBTJsDZ8H6nUNKBrNNbHND
=difT
-----END PGP SIGNATURE-----
--~--~---------~--~----~------------~-------~--~----~
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
-~----------~----~----~----~------~----~------~--~---
