conf Namespace Reference

Variables
string	needs_sphinx = '1.8.5'
list	extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.coverage', 'breathe']
dictionary	breathe_projects = { "CanModule": "./doxygen-result/xml" }
string	breathe_default_project = "CanModule"
list	templates_path = ['sphinx_templates']
string	source_suffix = '.rst'
string	master_doc = 'index'
string	project = u'CanModule'
string	copyright = u'2019, CERN, BE-ICS (Michael Ludwig)'
string	version = '1.1.9.7'
string	release = '1.1.9.7'
string	language = 'en'
string	today_fmt = '%B %d, %Y'
list	exclude_patterns = []
string	pygments_style = 'sphinx'
string	qthelp_basename = breathe_default_project
string	qthelp_namespace = 'BE-ICS-FD-CanModule'
string	qthelp_theme = 'haiku'
string	html_theme = 'nature'
dictionary	html_theme_options = {}
string	html_last_updated_fmt = '%d-%b-%Y %H:%M:%S'
dictionary	html_sidebars
bool	html_use_index = True
bool	html_split_index = False
bool	html_show_sourcelink = True
bool	html_show_sphinx = True
bool	html_show_copyright = True
string	htmlhelp_basename = 'CanModule'
dictionary	latex_elements
list	latex_documents
list	man_pages
list	texinfo_documents

Variable Documentation

breathe_default_project

string conf.breathe_default_project = "CanModule"

Definition at line 36 of file conf.py.

breathe_projects

dictionary conf.breathe_projects = { "CanModule": "./doxygen-result/xml" }

Definition at line 35 of file conf.py.

copyright

string conf.copyright = u'2019, CERN, BE-ICS (Michael Ludwig)'

Definition at line 52 of file conf.py.

exclude_patterns

list conf.exclude_patterns = []

Definition at line 75 of file conf.py.

extensions

list conf.extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.coverage', 'breathe']

Definition at line 29 of file conf.py.

html_last_updated_fmt

string conf.html_last_updated_fmt = '%d-%b-%Y %H:%M:%S'

Definition at line 145 of file conf.py.

html_show_copyright

bool conf.html_show_copyright = True

Definition at line 178 of file conf.py.

html_show_sourcelink

bool conf.html_show_sourcelink = True

Definition at line 172 of file conf.py.

html_show_sphinx

bool conf.html_show_sphinx = True

Definition at line 175 of file conf.py.

html_sidebars

dictionary conf.html_sidebars

Initial value:

=  {
   '**': ['globaltoc.html', 'sourcelink.html', 'searchbox.html'],
   'using/windows': ['windowssidebar.html', 'searchbox.html'],
}

Definition at line 152 of file conf.py.

html_split_index

bool conf.html_split_index = False

Definition at line 169 of file conf.py.

html_theme

string conf.html_theme = 'nature'

Definition at line 109 of file conf.py.

html_theme_options

dictionary conf.html_theme_options = {}

Definition at line 114 of file conf.py.

html_use_index

bool conf.html_use_index = True

Definition at line 166 of file conf.py.

htmlhelp_basename

string conf.htmlhelp_basename = 'CanModule'

Definition at line 189 of file conf.py.

language

string conf.language = 'en'

Definition at line 65 of file conf.py.

latex_documents

list conf.latex_documents

Initial value:

=  [
  ('index', 'CanModule.tex', u'CanModule Developer Documentation',
   u'Michael Ludwig', 'manual'),
]

Definition at line 207 of file conf.py.

latex_elements

dictionary conf.latex_elements

Initial value:

=  {
# The paper size ('letterpaper' or 'a4paper').
#'papersize': 'letterpaper',

# The font size ('10pt', '11pt' or '12pt').
#'pointsize': '10pt',

# Additional stuff for the LaTeX preamble.
#'preamble': '',
}

Definition at line 194 of file conf.py.

man_pages

list conf.man_pages

Initial value:

=  [
    ('index', 'test0', u'test0 Documentation',
     [u'Michael Ludwig'], 1)
]

Definition at line 237 of file conf.py.

master_doc

string conf.master_doc = 'index'

Definition at line 48 of file conf.py.

needs_sphinx

string conf.needs_sphinx = '1.8.5'

Definition at line 25 of file conf.py.

project

string conf.project = u'CanModule'

Definition at line 51 of file conf.py.

pygments_style

string conf.pygments_style = 'sphinx'

Definition at line 92 of file conf.py.

qthelp_basename

string conf.qthelp_basename = breathe_default_project

Definition at line 98 of file conf.py.

qthelp_namespace

string conf.qthelp_namespace = 'BE-ICS-FD-CanModule'

Definition at line 99 of file conf.py.

qthelp_theme

string conf.qthelp_theme = 'haiku'

Definition at line 100 of file conf.py.

release

string conf.release = '1.1.9.7'

Definition at line 61 of file conf.py.

source_suffix

string conf.source_suffix = '.rst'

Definition at line 42 of file conf.py.

templates_path

list conf.templates_path = ['sphinx_templates']

Definition at line 39 of file conf.py.

texinfo_documents

list conf.texinfo_documents

Initial value:

=  [
  ('index', 'test0', u'test0 Documentation',
   u'Michael Ludwig', 'test0', 'One line description of project.',
   'Miscellaneous'),
]

Definition at line 251 of file conf.py.

today_fmt

string conf.today_fmt = '%B %d, %Y'

Definition at line 71 of file conf.py.

version

string conf.version = '1.1.9.7'

Definition at line 59 of file conf.py.