conf Namespace Reference

Variables
list	extensions = []
list	templates_path = ['.templates']
string	source_suffix = '.rst'
string	master_doc = 'index'
string	project = u'Binder'
string	copyright = u'2016, Sergey Lyskov'
string	author = u'Sergey Lyskov'
string	version = u'0.1'
string	release = u'0.1'
	language = None
list	exclude_patterns = ['.build', 'Thumbs.db', '.DS_Store']
string	pygments_style = 'sphinx'
bool	todo_include_todos = False
string	html_theme = 'sphinx_rtd_theme'
string	on_rtd = 'True'
list	html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
dictionary	html_context
list	html_static_path = ['.static']
string	htmlhelp_basename = 'Binderdoc'
dictionary	latex_elements
list	latex_documents
list	man_pages
list	texinfo_documents
dictionary	html_sidebars
bool	html_split_index = True

Variable Documentation

author

string conf.author = u'Sergey Lyskov'

Referenced by basic::citation_manager::UnpublishedModuleInfo.get_author_list(), basic::citation_manager::Citation.get_default_formatted_citation(), and basic::citation_manager::Citation.get_nature_formatted_citation().

copyright

string conf.copyright = u'2016, Sergey Lyskov'

exclude_patterns

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

extensions

list conf.extensions = []

html_context

dictionary conf.html_context

Initial value:

=  {
        'css_files': [
            '_static/theme_overrides.css'
        ]
    }

html_sidebars

dictionary conf.html_sidebars

Initial value:

=  {
   '**': ['globaltoc.html', 'searchbox.html'],
}

html_split_index

bool conf.html_split_index = True

html_static_path

list conf.html_static_path = ['.static']

html_theme

string conf.html_theme = 'sphinx_rtd_theme'

html_theme_path

list conf.html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]

htmlhelp_basename

string conf.htmlhelp_basename = 'Binderdoc'

language

conf.language = None

latex_documents

list conf.latex_documents

Initial value:

=  [
    (master_doc, 'Binder.tex', u'Binder Documentation',
     u'Sergey Lyskov', 'manual'),
]

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

man_pages

list conf.man_pages

Initial value:

=  [
    (master_doc, 'binder', u'Binder Documentation',
     [author], 1)
]

master_doc

string conf.master_doc = 'index'

on_rtd

string conf.on_rtd = 'True'

project

string conf.project = u'Binder'

Referenced by ui::task.check_submit_requirements(), ui::task.save_project(), NodeTest.test_project_serialization(), and ui::task::FileTableModel.update_from_task().

pygments_style

string conf.pygments_style = 'sphinx'

release

string conf.release = u'0.1'

source_suffix

string conf.source_suffix = '.rst'

templates_path

list conf.templates_path = ['.templates']

texinfo_documents

list conf.texinfo_documents

Initial value:

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

todo_include_todos

bool conf.todo_include_todos = False

version

string conf.version = u'0.1'