conf Namespace Reference

Variables
list	extensions
string	source_suffix = '.rst'
string	master_doc = 'index'
string	project = 'ICS Framework'
string	copyright = '2018, ESO ELT Project'
string	author = 'ELT ICS Group'
string	version = '0.1.0'
string	release = '0.1.0-alpha'
	language = None
list	exclude_patterns = ['manuals/ifw/src/index.rst']
string	pygments_style = 'sphinx'
	todo_include_todos = True
string	html_theme = 'eso_theme'
list	html_theme_path = ['templates/sphinx-themes', ]
	html_show_sourcelink = False
	html_copy_source = False
dictionary	html_context = {}
	html_show_sphinx = False
string	htmlhelp_basename = 'ELTICSdoc'
dictionary	latex_elements
list	latex_documents
list	man_pages
list	texinfo_documents
	epub_title = project
	epub_author = author
	epub_publisher = author
	epub_copyright = copyright
list	epub_exclude_files = ['search.html']
dictionary	intersphinx_mapping
int	intersphinx_cache_limit = 0
list	templates_path = ['_templates']
list	html_static_path = ['_static']
string	html_logo = '_static/eso_logo.png'
string	html_favicon = '_static/eso-favicon.ico'

Variable Documentation

string conf.author = 'ELT ICS Group'

string conf.copyright = '2018, ESO ELT Project'

conf.epub_author = author

conf.epub_copyright = copyright

list conf.epub_exclude_files = ['search.html']

conf.epub_publisher = author

conf.epub_title = project

list conf.exclude_patterns = ['manuals/ifw/src/index.rst']

list conf.extensions

Initial value:

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

dictionary conf.html_context = {}

conf.html_copy_source = False

string conf.html_favicon = '_static/eso-favicon.ico'

string conf.html_logo = '_static/eso_logo.png'

conf.html_show_sourcelink = False

conf.html_show_sphinx = False

list conf.html_static_path = ['_static']

string conf.html_theme = 'eso_theme'

list conf.html_theme_path = ['templates/sphinx-themes', ]

string conf.htmlhelp_basename = 'ELTICSdoc'

int conf.intersphinx_cache_limit = 0

dictionary conf.intersphinx_mapping

Initial value:

= {
    'DevGuide': ('http://www.eso.org/~eeltmgr/ICS/documents/DeveloperGuide/build/html', None)
}

conf.language = None

list conf.latex_documents

Initial value:

= [
    (master_doc, 'ELTICSdoc.tex', 'ELT ICS Framework documentation',
     'ELT ICS Group', 'documentation'),
]

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, 'elticsdoc', 'ELT ICS Framework documentation',
     [author], 1)
]

string conf.master_doc = 'index'

string conf.project = 'ICS Framework'

string conf.pygments_style = 'sphinx'

string conf.release = '0.1.0-alpha'

string conf.source_suffix = '.rst'

list conf.templates_path = ['_templates']

list conf.texinfo_documents

Initial value:

= [
    (master_doc, 'ELTICSdoc', 'ELT ICS Framework documentation',
     author, 'ELTICSdoc', 'One line description of project.',
     'Miscellaneous'),
]

conf.todo_include_todos = True

string conf.version = '0.1.0'