doc/tools/generate_modules.py
author Quentin Roquefort <roquefort.quentin@gmail.com>
Thu, 28 Apr 2011 20:41:44 +0200
changeset 7277 acd7f0e9f276
parent 5424 8ecbcbff9777
child 8930 6a02be304486
permissions -rw-r--r--
[etwist] Generates apache's mod_concat-like urls for js and css Uses the lists of js, css and ie_css included in order to generate urls compatible with Apache mod_concat (ie: http://test.fr/??file1.js,file2.js). Css files may use `media` option or may be for IE only ; this patch does not concatenate css filenames for different media types or different IE specs. It concatenates only files served under cubicweb's `data` urls and keeps original include order. The generated urls are added to the HTML header as usual. HOW-TO: - calling HTMLHead(datadir_url) will enable the url concatenation - calling HTMLHead() will not benefit of url concatenation IMPORTANT NOTE: - fckeditor can no more be served under `/data/` segment

# copyright 2003-2010 LOGILAB S.A. (Paris, FRANCE), all rights reserved.
# contact http://www.logilab.fr/ -- mailto:contact@logilab.fr
#
# This file is part of CubicWeb.
#
# CubicWeb is free software: you can redistribute it and/or modify it under the
# terms of the GNU Lesser General Public License as published by the Free
# Software Foundation, either version 2.1 of the License, or (at your option)
# any later version.
#
# CubicWeb is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
# FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
# details.
#
# You should have received a copy of the GNU Lesser General Public License along
# with CubicWeb.  If not, see <http://www.gnu.org/licenses/>.
"""generate list of modules for sphinx doc

"""

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',))