doc/tools/generate_modules.py
author Pierre-Yves David <pierre-yves.david@logilab.fr>
Thu, 25 Mar 2010 15:11:44 +0100
branchstable
changeset 5020 30a539c2074d
parent 4831 c5aec27c1bf7
child 5421 8167de96c523
permissions -rw-r--r--
When a TC failed to initiliase the database, the following test are SKIPPED When a TC failed to initiliase the database, the other test of the same TestCase are skipped with an explicite message instead of failing later for with an unrelated message.

"""generate list of modules for sphinx doc

:organization: Logilab
:copyright: 2001-2010 LOGILAB S.A. (Paris, FRANCE), license is LGPL v2.
:contact: http://www.logilab.fr/ -- mailto:contact@logilab.fr
:license: GNU Lesser General Public License, v2.1 - http://www.gnu.org/licenses
"""

import sys

EXCLUDE_DIRS = ('test', 'tests', 'examples', 'data', 'doc', 'dist',
                '.hg', 'migration')
if __name__ == '__main__':

    from logilab.common.sphinxutils import ModuleGenerator
    cw_gen = ModuleGenerator('cubicweb', '../..')
    cw_gen.generate("../book/en/annexes/api_cubicweb.rst",
                    EXCLUDE_DIRS + ('cwdesklets', 'misc', 'skel', 'skeleton'))
    for modname in ('logilab', 'rql', 'yams'):
        cw_gen = ModuleGenerator(modname, '../../../' + modname)
        cw_gen.generate("../book/en/annexes/api_%s.rst" % modname,
                        EXCLUDE_DIRS + ('tools',))