conf Namespace Reference

Variables
	shell
str	project = 'EX-Display'
str	copyright = '2024, peteGSX'
str	author = 'peteGSX'
list	extensions
str	graphviz_output_format = 'png'
list	templates_path = ['_templates']
list	exclude_patterns = []
str	html_theme = 'sphinx_rtd_theme'
list	html_static_path = ['_static']
str	html_logo = "./_static/images/logo.png"
str	html_favicon = "./_static/images/favicon.ico"
dict	html_theme_options
dict	html_context
list	html_css_files
dict	breathe_projects
str	breathe_default_project = "EX-Display"
tuple	breathe_default_members = ()
bool	breathe_use_project_refids = True
bool	breathe_show_include_files = True
bool	breathe_show_grouped_typedefs = True
bool	breathe_use_inheritance_diagram = True
int	breathe_graph_maxoutdegree = 10
int	breathe_graph_maxdepth = 5
bool	breathe_show_include_graph = True
bool	breathe_show_collaboration_graph = True
bool	breathe_show_programlisting = True
dict	exhale_args

Variable Documentation

author

str conf.author = 'peteGSX'

breathe_default_members

tuple conf.breathe_default_members = ()

breathe_default_project

str conf.breathe_default_project = "EX-Display"

breathe_graph_maxdepth

int conf.breathe_graph_maxdepth = 5

breathe_graph_maxoutdegree

int conf.breathe_graph_maxoutdegree = 10

breathe_projects

dict conf.breathe_projects

Initial value:

=  {
  "EX-Display": "_build/xml/"
}

breathe_show_collaboration_graph

bool conf.breathe_show_collaboration_graph = True

breathe_show_grouped_typedefs

bool conf.breathe_show_grouped_typedefs = True

breathe_show_include_files

bool conf.breathe_show_include_files = True

breathe_show_include_graph

bool conf.breathe_show_include_graph = True

breathe_show_programlisting

bool conf.breathe_show_programlisting = True

breathe_use_inheritance_diagram

bool conf.breathe_use_inheritance_diagram = True

breathe_use_project_refids

bool conf.breathe_use_project_refids = True

copyright

str conf.copyright = '2024, peteGSX'

exclude_patterns

list conf.exclude_patterns = []

exhale_args

dict conf.exhale_args

Initial value:

=  {
    # Required arguments
    "containmentFolder":     "./ex-display",
    "rootFileName":          "ex-display_root.rst",
    "doxygenStripFromPath":  "..",
    # Suggested optional arguments
    "createTreeView":        True,
    "treeViewIsBootstrap":   True,
    # Include all the doxygen generated graphs
    "exhaleExecutesDoxygen": False,
    "generateBreatheFileDirectives": True,
}

extensions

list conf.extensions

Initial value:

=  [
  'breathe',
  'exhale',
  'sphinx.ext.autodoc',
  'sphinx.ext.graphviz',
]

graphviz_output_format

str conf.graphviz_output_format = 'png'

html_context

dict conf.html_context

Initial value:

=  {
    'display_github': True,
    'github_user': 'DCC-EX',
    'github_repo': 'EX-Display',
    'github_version': 'sphinx/docs/',
}

html_css_files

list conf.html_css_files

Initial value:

=  [
    'css/dccex_theme.css',
    'css/sphinx_design_overrides.css',
]

html_favicon

str conf.html_favicon = "./_static/images/favicon.ico"

html_logo

str conf.html_logo = "./_static/images/logo.png"

html_static_path

list conf.html_static_path = ['_static']

html_theme

str conf.html_theme = 'sphinx_rtd_theme'

html_theme_options

dict conf.html_theme_options

Initial value:

=  {
    'style_nav_header_background': 'white',
    'logo_only': True,
    # Toc options
    'includehidden': True,
    'titles_only': False,
    # 'titles_only': True,
    'collapse_navigation': False,
    # 'navigation_depth': 3,
    'navigation_depth': -1,
    # 'analytics_id': 'G-L5X0KNBF0W',
}

project

str conf.project = 'EX-Display'

shell

conf.shell

templates_path

list conf.templates_path = ['_templates']