conf Namespace Reference

Variables
list	extensions
list	templates_path = ['_templates']
string	source_suffix = '.rst'
string	master_doc = 'index'
string	project = u'COMPASS'
string	copyright = u'2013-2017, COMPASS team'
string	author = u'COMPASS team'
string	version = 'py3'
string	release = version + ' tag'
	language = None
list	exclude_patterns = []
string	pygments_style = 'sphinx'
bool	todo_include_todos = False
string	html_theme = "classic"
dictionary	html_theme_options = {"rightsidebar": "False", "stickysidebar": "True"}
string	html_logo = "compass.png"
list	html_static_path = ['_static']
string	htmlhelp_basename = 'COMPASSdoc'
dictionary	latex_elements
list	latex_documents
list	man_pages = [(master_doc, 'compass', u'COMPASS Documentation', [author], 1)]
list	texinfo_documents

Variable Documentation

author

string conf.author = u'COMPASS team'

Definition at line 59 of file conf.py.

copyright

string conf.copyright = u'2013-2017, COMPASS team'

Definition at line 58 of file conf.py.

exclude_patterns

list conf.exclude_patterns = []

Definition at line 85 of file conf.py.

extensions

list conf.extensions

Initial value:

=  [
        'sphinx.ext.autodoc',
]

Definition at line 38 of file conf.py.

html_logo

string conf.html_logo = "compass.png"

Definition at line 143 of file conf.py.

html_static_path

list conf.html_static_path = ['_static']

Definition at line 153 of file conf.py.

html_theme

string conf.html_theme = "classic"

Definition at line 120 of file conf.py.

html_theme_options

dictionary conf.html_theme_options = {"rightsidebar": "False", "stickysidebar": "True"}

Definition at line 121 of file conf.py.

htmlhelp_basename

string conf.htmlhelp_basename = 'COMPASSdoc'

Definition at line 216 of file conf.py.

language

conf.language = None

Definition at line 75 of file conf.py.

latex_documents

list conf.latex_documents

Initial value:

=  [
        (master_doc, 'COMPASS.tex', u'COMPASS Documentation', author, 'manual'),
]

Definition at line 237 of file conf.py.

latex_elements

dictionary conf.latex_elements

Initial value:

=  {
        # The paper size ('letterpaper' or 'a4paper').
        'papersize': 'a4paper',
 
        # The font size ('10pt', '11pt' or '12pt').
        # 'pointsize': '11pt',
 
        # Additional stuff for the LaTeX preamble.
        # 'preamble': '',
 
        # Latex figure (float) alignment
        # 'figure_align': 'htbp',
}

Definition at line 220 of file conf.py.

man_pages

list conf.man_pages = [(master_doc, 'compass', u'COMPASS Documentation', [author], 1)]

Definition at line 265 of file conf.py.

master_doc

string conf.master_doc = 'index'

Definition at line 54 of file conf.py.

project

string conf.project = u'COMPASS'

Definition at line 57 of file conf.py.

pygments_style

string conf.pygments_style = 'sphinx'

Definition at line 103 of file conf.py.

release

string conf.release = version + ' tag'

Definition at line 68 of file conf.py.

source_suffix

string conf.source_suffix = '.rst'

Definition at line 48 of file conf.py.

templates_path

list conf.templates_path = ['_templates']

Definition at line 43 of file conf.py.

texinfo_documents

list conf.texinfo_documents

Initial value:

=  [
        (master_doc, 'COMPASS', u'COMPASS Documentation', author, 'COMPASS',
         'One line description of project.', 'Miscellaneous'),
]

Definition at line 275 of file conf.py.

todo_include_todos

bool conf.todo_include_todos = False

Definition at line 112 of file conf.py.

version

string conf.version = 'py3'

Definition at line 66 of file conf.py.