Esempio n. 1
0
    # Now use breathe.apidoc to autogen rst files for each XML file
    apidoc_args = argparse.Namespace(destdir='_breathe_autogen/',
                                     dryrun=False,
                                     force=True,
                                     notoc=False,
                                     outtypes=("file"),
                                     project="BOUT++",
                                     rootpath='../doxygen/bout/xml',
                                     suffix='rst',
                                     members=True,
                                     quiet=False)
    apidoc_args.rootpath = os.path.abspath(apidoc_args.rootpath)
    if not os.path.isdir(apidoc_args.destdir):
        if not apidoc_args.dryrun:
            os.makedirs(apidoc_args.destdir)
    apidoc.recurse_tree(apidoc_args)
    for key, value in apidoc.TYPEDICT.items():
        apidoc.create_modules_toc_file(key, value, apidoc_args)

    # -- Options for breathe extension ----------------------------------------

    breathe_projects = {"BOUT++": "../doxygen/bout/xml"}
    breathe_default_project = "BOUT++"
    breathe_default_members = ("members", )

# -- General configuration ------------------------------------------------

# If your documentation needs a minimal Sphinx version, state it here.
#
# needs_sphinx = '1.0'
Esempio n. 2
0
        subprocess.call("cd ../doxygen; doxygen Doxyfile", shell=True)
    # Now use breathe.apidoc to autogen rst files for each XML file
    apidoc_args = argparse.Namespace(destdir='_breathe_autogen/',
                                     dryrun=False,
                                     force=True,
                                     notoc=False,
                                     outtypes=("file"),
                                     project="BOUT++",
                                     rootpath='../doxygen/bout/xml',
                                     suffix='rst',
                                     quiet=False)
    apidoc_args.rootpath = os.path.abspath(apidoc_args.rootpath)
    if not os.path.isdir(apidoc_args.destdir):
        if not apidoc_args.dryrun:
            os.makedirs(apidoc_args.destdir)
    apidoc.recurse_tree(apidoc_args)
    for key, value in apidoc.TYPEDICT.items():
       apidoc.create_modules_toc_file(key, value, apidoc_args)

    # -- Options for breathe extension ----------------------------------------

    breathe_projects = { "BOUT++": "../doxygen/bout/xml" }
    breathe_default_project = "BOUT++"
    breathe_default_members = ("members",)

# -- General configuration ------------------------------------------------

# If your documentation needs a minimal Sphinx version, state it here.
#
# needs_sphinx = '1.0'