conf Namespace Reference

Variables
tuple	on_rtd = os.environ.get('READTHEDOCS', None)
list	extensions = ['breathe']
dictionary	breathe_projects
string	breathe_default_project = 'CAFE'
list	templates_path = ['_templates']
string	source_suffix = '.rst'
string	master_doc = 'index'
string	project = u'CAFE'
string	copyright = u'2016, Mira V. Han, Gregg W.C. Thomas, and Mattheww W. Hahn'
string	author = u'Mira V. Han, Gregg W.C. Thomas, and Mattheww W. Hahn'
string	version = u'3.2'
string	release = u'3.2'
	language = None
list	exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
string	pygments_style = 'sphinx'
	todo_include_todos = False
string	html_theme = 'alabaster'
list	html_static_path = ['_static']
string	htmlhelp_basename = 'CAFEdoc'
dictionary	latex_elements
list	latex_documents
list	man_pages
list	texinfo_documents

Variable Documentation

string conf.author = u'Mira V. Han, Gregg W.C. Thomas, and Mattheww W. Hahn'

string conf.breathe_default_project = 'CAFE'

dictionary conf.breathe_projects

Initial value:

= {
    "CAFE":"xml/",
    }

string conf.copyright = u'2016, Mira V. Han, Gregg W.C. Thomas, and Mattheww W. Hahn'

list conf.exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']

list conf.extensions = ['breathe']

list conf.html_static_path = ['_static']

string conf.html_theme = 'alabaster'

string conf.htmlhelp_basename = 'CAFEdoc'

conf.language = None

list conf.latex_documents

Initial value:

= [
    (master_doc, 'CAFE.tex', u'CAFE Documentation',
     u'Mira V. Han, Gregg W.C. Thomas, and Mattheww W. Hahn', 'manual'),
]

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',
}

list conf.man_pages

Initial value:

= [
    (master_doc, 'cafe', u'CAFE Documentation',
     [author], 1)
]

string conf.master_doc = 'index'

tuple conf.on_rtd = os.environ.get('READTHEDOCS', None)

string conf.project = u'CAFE'

string conf.pygments_style = 'sphinx'

string conf.release = u'3.2'

string conf.source_suffix = '.rst'

list conf.templates_path = ['_templates']

list conf.texinfo_documents

Initial value:

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

conf.todo_include_todos = False

string conf.version = u'3.2'