conf Namespace Reference

Variables
string	project = "Gaudi"
string	copyright = "1998-2023, CERN for the benefit of the LHCb and ATLAS collaborations"
string	author = "The Gaudi Developers"
string	version = "39.2"
string	release = "v39r2"
list	extensions = ["sphinx.ext.autodoc", "recommonmark"]
list	templates_path = ["_templates"]
dictionary	source_suffix
string	master_doc = "index"
	language = None
list	exclude_patterns = []
	pygments_style = None
string	html_theme = "sphinx_rtd_theme"
string	html_logo = "gaudilogo_square.png"
list	html_static_path = ["_static"]
string	htmlhelp_basename = "Gaudidoc"
dictionary	latex_elements
list	latex_documents
list	man_pages = [(master_doc, "gaudi", "Gaudi Documentation", [author], 1)]
list	texinfo_documents
string	epub_title = project
list	epub_exclude_files = ["search.html"]
bool	numfig = True

Variable Documentation

author

string conf.author = "The Gaudi Developers"

Definition at line 22 of file conf.py.

copyright

string conf.copyright = "1998-2023, CERN for the benefit of the LHCb and ATLAS collaborations"

Definition at line 21 of file conf.py.

epub_exclude_files

list conf.epub_exclude_files = ["search.html"]

Definition at line 169 of file conf.py.

epub_title

string conf.epub_title = project

Definition at line 157 of file conf.py.

exclude_patterns

list conf.exclude_patterns = []

Definition at line 67 of file conf.py.

extensions

list conf.extensions = ["sphinx.ext.autodoc", "recommonmark"]

Definition at line 38 of file conf.py.

html_logo

string conf.html_logo = "gaudilogo_square.png"

Definition at line 79 of file conf.py.

html_static_path

list conf.html_static_path = ["_static"]

Definition at line 90 of file conf.py.

html_theme

string conf.html_theme = "sphinx_rtd_theme"

Definition at line 77 of file conf.py.

htmlhelp_basename

string conf.htmlhelp_basename = "Gaudidoc"

Definition at line 105 of file conf.py.

language

conf.language = None

Definition at line 62 of file conf.py.

latex_documents

list conf.latex_documents

Initial value:

=  [
    (master_doc, "Gaudi.tex", "Gaudi Documentation", "Gaudi Developers", "manual"),
]

Definition at line 127 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': '',
    # Latex figure (float) alignment
    #
    # 'figure_align': 'htbp',
}

Definition at line 109 of file conf.py.

man_pages

list conf.man_pages = [(master_doc, "gaudi", "Gaudi Documentation", [author], 1)]

Definition at line 135 of file conf.py.

master_doc

string conf.master_doc = "index"

Definition at line 55 of file conf.py.

numfig

bool conf.numfig = True

Definition at line 173 of file conf.py.

project

string conf.project = "Gaudi"

Definition at line 20 of file conf.py.

pygments_style

conf.pygments_style = None

Definition at line 70 of file conf.py.

release

string conf.release = "v39r2"

Definition at line 27 of file conf.py.

source_suffix

dictionary conf.source_suffix

Initial value:

=  {
    ".rst": "restructuredtext",
    ".txt": "markdown",
    ".md": "markdown",
}

Definition at line 48 of file conf.py.

templates_path

list conf.templates_path = ["_templates"]

Definition at line 41 of file conf.py.

texinfo_documents

list conf.texinfo_documents

Initial value:

=  [
    (
        master_doc,
        "Gaudi",
        "Gaudi Documentation",
        author,
        "Gaudi",
        "One line description of project.",
        "Miscellaneous",
    ),
]

Definition at line 142 of file conf.py.

version

string conf.version = "39.2"

Definition at line 25 of file conf.py.