conf Namespace Reference

Variables
str	project = 'ABACUS-source_basis/module_ao'
str	copyright = '2021, x'
str	author = 'mohan'
str	release = '0.1'
list	extensions
list	templates_path = ['_templates']
list	exclude_patterns = []
str	html_theme = "sphinx_rtd_theme"
list	html_static_path = ['_static']
dict	breathe_projects = { "ABACUS-source_basis/module_ao": "../../doxygen/xml/" }
str	breathe_default_project = "ABACUS-source_basis/module_ao"
dict	exhale_args
str	primary_domain = 'cpp'
str	highlight_language = 'cpp'

Variable Documentation

author

str conf.author = 'mohan'

breathe_default_project

str conf.breathe_default_project = "ABACUS-source_basis/module_ao"

breathe_projects

dict conf.breathe_projects = { "ABACUS-source_basis/module_ao": "../../doxygen/xml/" }

copyright

str conf.copyright = '2021, x'

exclude_patterns

list conf.exclude_patterns = []

exhale_args

dict conf.exhale_args

Initial value:

=  {
    # These arguments are required
    "containmentFolder":     "./ORB_api",
    "rootFileName":          "library_root.rst",
    "rootFileTitle":         "ORB API",
    "doxygenStripFromPath":  "..",
    # Suggested optional arguments
    "createTreeView":        True,
    # TIP: if using the sphinx-bootstrap-theme, you need
    # "treeViewIsBootstrap": True,
    "exhaleExecutesDoxygen": True,
    "exhaleDoxygenStdin":    "INPUT = ../../.."
}

extensions

list conf.extensions

Initial value:

=  [ 'sphinx.ext.todo', 'breathe', 'exhale', 'sphinx.ext.mathjax', "sphinx_rtd_theme", 'myst_parser'
]

highlight_language

str conf.highlight_language = 'cpp'

html_static_path

list conf.html_static_path = ['_static']

html_theme

str conf.html_theme = "sphinx_rtd_theme"

primary_domain

str conf.primary_domain = 'cpp'

project

str conf.project = 'ABACUS-source_basis/module_ao'

release

str conf.release = '0.1'

templates_path

list conf.templates_path = ['_templates']