Python sphinx_build Examples

Example #1

def build(clean=True, **kwargs):
    from sphinx import main as sphinx_build
    print "building %s - %s" % (docsdir, datetime.datetime.now())

    if not os.path.isdir(gendir):
        generate()

    os.chdir(docsdir)
    if clean:
        clean_build()

    copy_changelog()

    #mkdir -p build/html build/doctrees

    #import pymel.internal.cmdcache as cmdcache
    #cmdcache.fixCodeExamples()
    opts = ['']
    opts += '-b html -d build/doctrees'.split()

    # set some defaults
    if not kwargs.get('graphviz_dot', None):
        kwargs['graphviz_dot'] = find_dot()

    for key, value in kwargs.iteritems():
        opts.append('-D')
        opts.append(key.strip() + '=' + value.strip())
    opts.append('-P')
    opts.append(SOURCE)
    opts.append(BUILD)
    sphinx_build(opts)
    print "...done building %s - %s" % (docsdir, datetime.datetime.now())

Example #2

File: docs.py Project: Leopardob/pymel

def build(clean=True, **kwargs):
    from sphinx import main as sphinx_build
    print "building %s - %s" % (docsdir, datetime.datetime.now())

    if not os.path.isdir(gendir):
        generate()

    os.chdir( docsdir )
    if clean:
        clean_build()

    copy_changelog()

    #mkdir -p build/html build/doctrees

    #import pymel.internal.cmdcache as cmdcache
    #cmdcache.fixCodeExamples()
    opts = ['']
    opts += '-b html -d build/doctrees'.split()

    # set some defaults
    if not kwargs.get('graphviz_dot', None):
        kwargs['graphviz_dot'] = find_dot()

    for key, value in kwargs.iteritems():
        opts.append('-D')
        opts.append( key.strip() + '=' + value.strip() )
    opts.append('-P')
    opts.append(SOURCE)
    opts.append(BUILD)
    sphinx_build(opts)
    print "...done building %s - %s" % (docsdir, datetime.datetime.now())

Example #3

File: docs.py Project: zewt/pymel

def build(clean=True, opts=None, filenames=None, **kwargs):
    from sphinx import main as sphinx_build
    print("building %s - %s" % (docsdir, datetime.datetime.now()))

    if clean or not os.path.isdir(gendir):
        generate(clean=clean)

    os.chdir(docsdir)
    if clean:
        clean_build()

    copy_changelog()

    #mkdir -p build/html build/doctrees

    #import pymel.internal.cmdcache as cmdcache
    #cmdcache.fixCodeExamples()
    if opts is None:
        opts = ['']
    else:
        opts = [''] + lists(opts)
    opts += '-b html -d build/doctrees'.split()

    # set some defaults
    dot = kwargs.get('graphviz_dot')
    if dot is None:
        kwargs['graphviz_dot'] = find_dot()
    else:
        if not os.path.isfile(dot):
            raise RuntimeError("passed in graphviz_dot binary did not exist:"
                               " {}".format(dot))

    for key, value in kwargs.items():
        opts.append('-D')
        opts.append(key.strip() + '=' + value.strip())
    opts.append('-P')
    opts.append(SOURCE)
    opts.append(BUILD)
    if filenames is not None:
        opts.extend(filenames)
    print("sphinx_build({!r})".format(opts))

    with NoSubprocessWindow():
        sphinx_build(opts)
    print("...done building %s - %s" % (docsdir, datetime.datetime.now()))

Example #4

File: build_docs.py Project: rkoschmitzky/nodex

def build(clean=True, **kwargs):
    print "building %s - %s" % (docsdir, datetime.datetime.now())

    os.chdir(docsdir)
    if clean:
        clean_build()

    #mkdir -p build/html build/doctrees

    opts = ['']
    opts += '-b html -d build/doctrees'.split()

    for key, value in kwargs.iteritems():
        opts.append('-D')
        opts.append(key.strip() + '=' + value.strip())
    opts.append('-P')
    opts.append(SOURCE)
    opts.append(BUILD)
    sphinx_build(opts)
    print "...done building %s - %s" % (docsdir, datetime.datetime.now())

Example #5

File: build_docs.py Project: BigRoy/nodex

def build(clean=True, **kwargs):
    print "building %s - %s" % (docsdir, datetime.datetime.now())

    os.chdir( docsdir )
    if clean:
        clean_build()

    #mkdir -p build/html build/doctrees

    opts = ['']
    opts += '-b html -d build/doctrees'.split()

    for key, value in kwargs.iteritems():
        opts.append('-D')
        opts.append( key.strip() + '=' + value.strip() )
    opts.append('-P')
    opts.append(SOURCE)
    opts.append(BUILD)
    sphinx_build(opts)
    print "...done building %s - %s" % (docsdir, datetime.datetime.now())

Example #6

def build(clean=True, **kwargs):
    os.chdir( docsdir )
    if clean:
        clean_generated()
        clean_build()

    #mkdir -p build/html build/doctrees

    #import pymel.internal.cmdcache as cmdcache
    #cmdcache.fixCodeExamples()
    opts = ['']
    opts += '-b html -d build/doctrees'.split()

    # set some defaults
    if 'graphviz_dot' not in kwargs:
        kwargs['graphviz_dot'] = find_dot()

    for key, value in kwargs.iteritems():
        opts.append('-D')
        opts.append( key.strip() + '=' + value.strip() )
    opts.append('-P')
    opts.append(SOURCE)
    opts.append(BUILD)
    sphinx_build(opts)

Example #7

            "release={current}",
            "-D",
            "templates_path={templates}",
            "-D",
            "extensions={extensions}",
            "{docsfolder}",
        ]
        + add_argv
        + [
            "_build/html/{current}",
        ]
    )
    if argv_prefix:
        argv = argv_prefix + argv

    mapping = locals()
    argv = list(map(lambda x: x.format(**mapping), argv))

    cwd = os.getcwd()
    os.chdir(docsfolder)

    print("Running sphinx-build {}".format(" ".join(argv)))

    try:
        status = sphinx_build(argv)
        if status not in (0, None):
            print("sphinx build failed", file=sys.stderr)
            sys.exit(-2)
    finally:
        os.chdir(cwd)