| author | Sylvain Thénault <sylvain.thenault@logilab.fr> |
| Fri, 16 Oct 2009 14:37:11 +0200 | |
| branch | stable |
| changeset 3700 | fd550e4dc515 |
| parent 2612 | c3059d308dc2 |
| child 4212 | ab6573088b4a |
| permissions | -rw-r--r-- |
|
1977
606923dff11b
big bunch of copyright / docstring update
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
1808
diff
changeset
|
1 |
"""generate list of modules for sphinx doc |
|
606923dff11b
big bunch of copyright / docstring update
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
1808
diff
changeset
|
2 |
|
|
606923dff11b
big bunch of copyright / docstring update
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
1808
diff
changeset
|
3 |
:organization: Logilab |
|
606923dff11b
big bunch of copyright / docstring update
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
1808
diff
changeset
|
4 |
:copyright: 2001-2009 LOGILAB S.A. (Paris, FRANCE), license is LGPL v2. |
|
606923dff11b
big bunch of copyright / docstring update
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
1808
diff
changeset
|
5 |
:contact: http://www.logilab.fr/ -- mailto:contact@logilab.fr |
|
606923dff11b
big bunch of copyright / docstring update
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
1808
diff
changeset
|
6 |
:license: GNU Lesser General Public License, v2.1 - http://www.gnu.org/licenses |
|
606923dff11b
big bunch of copyright / docstring update
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
1808
diff
changeset
|
7 |
""" |
|
1693
49075f57cf2c
use logilab.common.sphinxutils
Emile Anclin <emile.anclin@logilab.fr>
parents:
299
diff
changeset
|
8 |
|
|
299
4761e0ca406d
[doc] Adds scripts to auto-generate modules list to index and add to the documentation.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff
changeset
|
9 |
import sys |
|
4761e0ca406d
[doc] Adds scripts to auto-generate modules list to index and add to the documentation.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff
changeset
|
10 |
|
|
2612
c3059d308dc2
[doc] update generate_modules to match new sphinxutils API
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
1977
diff
changeset
|
11 |
EXCLUDE_DIRS = ('test', 'tests', 'examples', 'data', 'doc', 'dist', |
|
c3059d308dc2
[doc] update generate_modules to match new sphinxutils API
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
1977
diff
changeset
|
12 |
'.hg', 'migration') |
|
1693
49075f57cf2c
use logilab.common.sphinxutils
Emile Anclin <emile.anclin@logilab.fr>
parents:
299
diff
changeset
|
13 |
if __name__ == '__main__': |
|
299
4761e0ca406d
[doc] Adds scripts to auto-generate modules list to index and add to the documentation.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
diff
changeset
|
14 |
|
|
2612
c3059d308dc2
[doc] update generate_modules to match new sphinxutils API
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
1977
diff
changeset
|
15 |
from logilab.common.sphinxutils import ModuleGenerator |
|
c3059d308dc2
[doc] update generate_modules to match new sphinxutils API
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
1977
diff
changeset
|
16 |
cw_gen = ModuleGenerator('cubicweb', '../..') |
|
c3059d308dc2
[doc] update generate_modules to match new sphinxutils API
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
1977
diff
changeset
|
17 |
cw_gen.generate("../book/en/annexes/api_cubicweb.rst", |
|
c3059d308dc2
[doc] update generate_modules to match new sphinxutils API
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
1977
diff
changeset
|
18 |
EXCLUDE_DIRS + ('cwdesklets', 'misc', 'skel', 'skeleton')) |
|
c3059d308dc2
[doc] update generate_modules to match new sphinxutils API
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
1977
diff
changeset
|
19 |
for modname in ('indexer', 'logilab', 'rql', 'yams'): |
|
c3059d308dc2
[doc] update generate_modules to match new sphinxutils API
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
1977
diff
changeset
|
20 |
cw_gen = ModuleGenerator(modname, '../../../' + modname) |
|
c3059d308dc2
[doc] update generate_modules to match new sphinxutils API
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
1977
diff
changeset
|
21 |
cw_gen.generate("../book/en/annexes/api_%s.rst" % modname, |
|
c3059d308dc2
[doc] update generate_modules to match new sphinxutils API
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
1977
diff
changeset
|
22 |
EXCLUDE_DIRS + ('tools',)) |