On Jan 28, 8:15 am, Roger Binns <[email protected]> wrote:
> -----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
Thank you.
Meanwhile, I found Sphinx tutorials at Pylons book:
http://pylonsbook.com/alpha1/documenting_a_pylons_project
This is a really nice introduction to Sphinx.
--~--~---------~--~----~------------~-------~--~----~
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
-~----------~----~----~----~------~----~------~--~---
