diff options
author | Julien Jehannet <julien.jehannet@logilab.fr> | 2010-03-24 18:43:25 +0100 |
---|---|---|
committer | Julien Jehannet <julien.jehannet@logilab.fr> | 2010-03-24 18:43:25 +0100 |
commit | 9d586d64ee08c64eae07d1d5527ae0c25de888eb (patch) | |
tree | 8af58f43254bdcaeb8cb5fee52cf23116b2a0259 /sphinxutils.py | |
parent | d357ea88211fc3abdfdddcda1a97a625325cc804 (diff) | |
download | logilab-common-9d586d64ee08c64eae07d1d5527ae0c25de888eb.tar.gz |
[D] doc: fix some restructured blocks
Diffstat (limited to 'sphinxutils.py')
-rw-r--r-- | sphinxutils.py | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/sphinxutils.py b/sphinxutils.py index 3889362..5615943 100644 --- a/sphinxutils.py +++ b/sphinxutils.py @@ -1,12 +1,12 @@ -""" -Sphinx utils: +"""Sphinx utils -* ModuleGenerator: Generate a file that lists all the modules of a list of - packages in order to pull all the docstring. - /!\ This should not be used in a makefile to systematically generate - sphinx documentation! +ModuleGenerator: Generate a file that lists all the modules of a list of +packages in order to pull all the docstring. +This should not be used in a makefile to systematically generate sphinx +documentation! Typical usage: + >>> from logilab.common.sphinxutils import ModuleGenerator >>> mgen = ModuleGenerator('logilab common', '/home/adim/src/logilab/common') >>> mgen.generate('api_logilab_common.rst', exclude_dirs=('test',)) |