conf Namespace Reference

Variables
list	extensions
list	templates_path = ['_templates']
string	source_suffix = '.rst'
string	master_doc = 'index'
string	project = u'breastMass'
string	copyright = u'2018, Christian G. Graff'
string	author = u'Christian G. Graff'
string	version = u'1.0'
string	release = u'1.0'
	language = None
list	exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
string	pygments_style = 'sphinx'
	todo_include_todos = False
string	html_theme = 'alabaster'
dictionary	html_theme_options
	html_show_copyright = False
list	html_static_path = ['_static']
dictionary	html_sidebars
string	htmlhelp_basename = 'breastMassdoc'
dictionary	latex_elements
list	latex_documents
list	man_pages
list	texinfo_documents
dictionary	intersphinx_mapping = {'https://docs.python.org/': None}

Variable Documentation

string conf.author = u'Christian G. Graff'

string conf.copyright = u'2018, Christian G. Graff'

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

list conf.extensions

Initial value:

= ['sphinx.ext.intersphinx',
    'sphinx.ext.mathjax',
    'sphinx.ext.githubpages']

conf.html_show_copyright = False

dictionary conf.html_sidebars

Initial value:

= {
    '**': [
        'about.html',
        'globaltoc.html',
        'relations.html',  # needs 'show_related': True theme option to display
        'searchbox.html',
    ]
}

list conf.html_static_path = ['_static']

string conf.html_theme = 'alabaster'

dictionary conf.html_theme_options

Initial value:

= {
    'logo': 'massLogo.png',
    'logo_name': 'true',
    'description': 'breast mass generation',
    'font_family': 'Helvetica',
    'head_font_family': 'Helvetica',
    'font_size': '12pt',
    'fixed_sidebar': 'true',
    'page_width': '1200px',
    'sidebar_width': '250px',
    'github_user': 'DIDSR',
    'github_repo': 'breastMass',
    'github_button': 'true'
}

string conf.htmlhelp_basename = 'breastMassdoc'

dictionary conf.intersphinx_mapping = {'https://docs.python.org/': None}

conf.language = None

list conf.latex_documents

Initial value:

= [
    (master_doc, 'breastMass.tex', u'breastMass Documentation',
     u'Christian G. Graff', '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',
    'extraclassoptions': 'openany,oneside'    
}

list conf.man_pages

Initial value:

= [
    (master_doc, 'breastmass', u'breastMass Documentation',
     [author], 1)
]

string conf.master_doc = 'index'

string conf.project = u'breastMass'

string conf.pygments_style = 'sphinx'

string conf.release = u'1.0'

string conf.source_suffix = '.rst'

list conf.templates_path = ['_templates']

list conf.texinfo_documents

Initial value:

= [
    (master_doc, 'breastMass', u'breastMass Documentation',
     author, 'breastMass', 'breast mass generation',
     'Miscellaneous'),
]

conf.todo_include_todos = False

string conf.version = u'1.0'