doc/tools/generate_modules.py
author Sylvain Thénault <sylvain.thenault@logilab.fr>
Mon, 25 Jan 2010 19:13:17 +0100
changeset 4337 27ea69e2cfea
parent 4212 ab6573088b4a
child 4831 c5aec27c1bf7
permissions -rw-r--r--
refactor attributes'value generator to deal with yams special Attribute/NOW/TODAY values that may be used on [Interval]BoundConstraint (BoundConstraint wasn't handled btw, fix this). Besides passing 'entity' to generate_* function (needed to get value for another attribute when computing one for instance): * set nicer method names and makes clearer what's private/protected/public * properly handle choices, constraints on float/date/datetime fields

"""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 ('indexer', 'logilab', 'rql', 'yams'):
        cw_gen = ModuleGenerator(modname, '../../../' + modname)
        cw_gen.generate("../book/en/annexes/api_%s.rst" % modname,
                        EXCLUDE_DIRS + ('tools',))