def specificationsForC(kind):
return []
exhale_projects_args = {
"peafowl-c": {
"exhaleDoxygenStdin":
"INPUT = ../include/peafowl/peafowl.h",
"containmentFolder":
"./api_c",
"rootFileTitle":
"Peafowl C API",
"customSpecificationsMapping":
utils.makeCustomSpecificationsMapping(specificationsForC)
},
"peafowl-cpp": {
"exhaleDoxygenStdin":
"INPUT = ../include/peafowl/peafowl.hpp",
"containmentFolder":
"./api_cpp",
"rootFileTitle":
"Peafowl C++ API",
"customSpecificationsMapping":
utils.makeCustomSpecificationsMapping(specificationsForCPP)
},
}
breathe_default_project = "peafowl-c"
"rootFileTitle": "n2p2 code documentation",
"doxygenStripFromPath": "..",
# Suggested optional arguments
"createTreeView": True,
# TIP: if using the sphinx-bootstrap-theme, you need
# "treeViewIsBootstrap": True,
"exhaleExecutesDoxygen": True,
"exhaleDoxygenStdin": "INPUT = ../../../libnnp\n"
"INPUT += ../../../libnnpif\n"
"INPUT += ../../../libnnptrain\n"
"XML_PROGRAMLISTING = YES\n"
"EXTRACT_ALL = YES\n"
"EXTRACT_PRIVATE = YES\n"
"EXTRACT_STATIC = YES\n"
"EXTRACT_LOCAL_CLASSES = YES\n",
"customSpecificationsMapping": utils.makeCustomSpecificationsMapping(specificationsForKind)
}
# Tell sphinx what the primary language being documented is.
primary_domain = 'cpp'
# Tell sphinx what the pygments highlight language should be.
highlight_language = 'cpp'
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
# An empty list signals to Exhale to use the defaults
else:
return []
exhale_args = {
# These arguments are required
"containmentFolder":
"cppapi",
"rootFileName":
"library_root.rst",
"rootFileTitle":
"C++ Library API",
"doxygenStripFromPath":
"..",
"customSpecificationsMapping":
utils.makeCustomSpecificationsMapping(specifications_for_kind),
# Suggested optional arguments
"createTreeView":
True,
"exhaleExecutesDoxygen":
True,
"exhaleDoxygenStdin":
"INPUT = {}".format(os.path.join(package_dir, "include"))
}
# -- Options for HTML output -------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'sphinx_rtd_theme'