Exemple #1
0
def build(buildenv):

    # Build API documentation into api subdirectory (except dos windows)

    if buildenv['os'] != 'win' or sys.platform == 'cygwin':
        hardhatlib.epydoc(buildenv, info['name'], 'Generating API docs',
                          '-o api -v -n chandlerdb',
                          '--no-private', '--inheritance listed',
                          'item', 'persistence', 'schema', 'util')
Exemple #2
0
def generateDocs(buildenv):

    # Generate the content model docs (configure your webserver to map
    # /docs/current/model to chandler/docs/model)
    args = [
        os.path.join('distrib', 'docgen', 'genmodeldocs.py'), '-u',
        '/docs/current/model'
    ]
    hardhatlib.executeScript(buildenv, args)

    # Generate the epydocs
    targetDir = os.path.join("docs", "api")
    hardhatlib.mkdirs(targetDir)
    if buildenv['os'] != 'win' or sys.platform == 'cygwin':
        hardhatlib.epydoc(buildenv, info['name'], 'Generating API docs',
                          '-o %s -v -n Chandler' % targetDir,
                          '--inheritance listed', '--no-private',
                          'application', 'parcels/osaf/sharing',
                          'repository/item', 'repository/persistence',
                          'repository/util', 'repository/query',
                          'repository/schema', 'crypto')
Exemple #3
0
def generateDocs(buildenv):

    # Generate the content model docs (configure your webserver to map
    # /docs/current/model to chandler/docs/model)
    args = [os.path.join('distrib', 'docgen', 'genmodeldocs.py'), '-u',
     '/docs/current/model']
    hardhatlib.executeScript(buildenv, args)

    # Generate the epydocs
    targetDir = os.path.join("docs","api")
    hardhatlib.mkdirs(targetDir)
    if buildenv['os'] != 'win' or sys.platform == 'cygwin':
        hardhatlib.epydoc(buildenv, info['name'], 'Generating API docs',
                          '-o %s -v -n Chandler' % targetDir,
                          '--inheritance listed',
                          '--no-private',
                          'application',
                          'parcels/osaf/sharing',
                          'repository/item',
                          'repository/persistence',
                          'repository/util',
                          'repository/query',
                          'repository/schema',
                          'crypto')
Exemple #4
0
        if opt == "-g" or opt == "--docs":
            hardhatlib.generateDocs(buildenv, curmodulepath)

        if opt == "-h" or opt == "--help":
            usage()

        if opt == "-i" or opt == "--interact":
            py = buildenv['python']
            if( buildenv['version'] == 'debug' ):
                py = buildenv['python_d']
            hardhatlib.executeCommandNoCapture(buildenv, "Interactive",
             [py], "Interactive session")

        if opt == "-j" or opt == "--epydoc":
            hardhatlib.epydoc(buildenv, None, None, arg, *args)

        if opt == "-l" or opt == "--lint":
            args_used = True  # we're going to be using the leftover args
            hardhatlib.lint(buildenv, args)

        if opt == "-n" or opt == "--noprompt":
            buildenv['interactive'] = False

        if opt == "-o" or opt == "--output":
            buildenv['outputdir'] = arg

        if opt == "-r" or opt == "--release":
            buildenv['version'] = 'release'

        if opt == "-s" or opt == "--scrub":