conf Namespace Reference

Variables
list	extensions
list	templates_path = ['_templates']
string	source_suffix = '.rst'
string	master_doc = 'index'
string	project = 'Building UFO in OS X'
string	copyright = '2018, Stephen Herbener'
string	author = 'Stephen Herbener'
string	version = '1.0'
string	release = '1.0.1'
	language = None
list	exclude_patterns = []
string	pygments_style = 'sphinx'
bool	todo_include_todos = True
string	html_theme = 'default'
list	html_static_path = ['_static']
dictionary	html_sidebars
string	htmlhelp_basename = 'BuildingUFOinOSXdoc'
dictionary	latex_elements
list	latex_documents
list	man_pages
list	texinfo_documents
dictionary	intersphinx_mapping = {'https://docs.python.org/': None}

Variable Documentation

author

string conf.author = 'Stephen Herbener'

Definition at line 58 of file conf.py.

copyright

string conf.copyright = '2018, Stephen Herbener'

Definition at line 57 of file conf.py.

exclude_patterns

list conf.exclude_patterns = []

Definition at line 79 of file conf.py.

extensions

list conf.extensions

Initial value:

=  ['sphinx.ext.autodoc',
    'sphinx.ext.doctest',
    'sphinx.ext.intersphinx',
    'sphinx.ext.todo',
    'sphinx.ext.coverage',
    'sphinx.ext.mathjax',
    'sphinx.ext.ifconfig',
    'sphinx.ext.viewcode']

Definition at line 34 of file conf.py.

html_sidebars

dictionary conf.html_sidebars

Initial value:

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

Definition at line 111 of file conf.py.

html_static_path

list conf.html_static_path = ['_static']

Definition at line 104 of file conf.py.

html_theme

string conf.html_theme = 'default'

Definition at line 93 of file conf.py.

htmlhelp_basename

string conf.htmlhelp_basename = 'BuildingUFOinOSXdoc'

Definition at line 122 of file conf.py.

intersphinx_mapping

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

Definition at line 179 of file conf.py.

language

conf.language = None

Definition at line 74 of file conf.py.

latex_documents

list conf.latex_documents

Initial value:

=  [
    (master_doc, 'BuildingUFOinOSX.tex', 'Building UFO in OS X Documentation',
     'Stephen Herbener', 'manual'),
]

Definition at line 148 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 127 of file conf.py.

man_pages

list conf.man_pages

Initial value:

=  [
    (master_doc, 'buildingufoinosx', 'Building UFO in OS X Documentation',
     [author], 1)
]

Definition at line 158 of file conf.py.

master_doc

string conf.master_doc = 'index'

Definition at line 53 of file conf.py.

project

string conf.project = 'Building UFO in OS X'

Definition at line 56 of file conf.py.

pygments_style

string conf.pygments_style = 'sphinx'

Definition at line 82 of file conf.py.

release

string conf.release = '1.0.1'

Definition at line 67 of file conf.py.

source_suffix

string conf.source_suffix = '.rst'

Definition at line 50 of file conf.py.

templates_path

list conf.templates_path = ['_templates']

Definition at line 44 of file conf.py.

texinfo_documents

list conf.texinfo_documents

Initial value:

=  [
    (master_doc, 'BuildingUFOinOSX', 'Building UFO in OS X Documentation',
     author, 'BuildingUFOinOSX', 'One line description of project.',
     'Miscellaneous'),
]

Definition at line 169 of file conf.py.

todo_include_todos

bool conf.todo_include_todos = True

Definition at line 85 of file conf.py.

version

string conf.version = '1.0'

Definition at line 65 of file conf.py.