conf Namespace Reference

Variables
list	extensions
string	source_suffix = '.rst'
string	master_doc = 'index'
string	project = 'ELT ICS Function Control Framework'
string	copyright = ' 2021 ESO - European Southern Observatory'
string	author = 'Mario Kiekebusch'
string	homepage = r'https://gitlab.eso.org/ifw/fcf'
	latex_attrs
	Update for each release: More...
string	version = '5.0.0-pre2'
string	release = version
	language = None
string	pygments_style = 'sphinx'
bool	todo_include_todos = True
string	html_theme = 'sphinx_eso_theme'
list	html_theme_path = ['_themes/', ]
bool	html_show_sourcelink = False
bool	html_copy_source = False
dictionary	html_context = {}
bool	html_show_sphinx = False
string	htmlhelp_basename = 'ELTICSdoc'
string	latex_engine = 'pdflatex'
dictionary	latex_elements
string	latex_show_urls = 'footnote'
list	latex_documents
list	man_pages
list	texinfo_documents
string	epub_title = project
string	epub_author = author
string	epub_publisher = author
string	epub_copyright = copyright
list	epub_exclude_files = ['search.html']
dictionary	intersphinx_mapping
int	intersphinx_cache_limit = 0
dictionary	extlinks

Variable Documentation

author

string conf.author = 'Mario Kiekebusch'

copyright

string conf.copyright = ' 2021 ESO - European Southern Observatory'

epub_author

string conf.epub_author = author

epub_copyright

string conf.epub_copyright = copyright

epub_exclude_files

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

epub_publisher

string conf.epub_publisher = author

epub_title

string conf.epub_title = project

extensions

list conf.extensions

Initial value:

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

extlinks

dictionary conf.extlinks

Initial value:

=  {
    'doxydoc': ('http://www.eso.org/~eltmgr/ICS/documents/doxygenDocumentation/%s', ''),
    'esogitlab': ('https://gitlab.eso.org/%s', ''),
    'esojira': ('https://jira.eso.org/%s', ''),
}

homepage

string conf.homepage = r'https://gitlab.eso.org/ifw/fcf'

html_context

dictionary conf.html_context = {}

html_copy_source

bool conf.html_copy_source = False

html_show_sourcelink

bool conf.html_show_sourcelink = False

html_show_sphinx

bool conf.html_show_sphinx = False

html_theme

string conf.html_theme = 'sphinx_eso_theme'

html_theme_path

list conf.html_theme_path = ['_themes/', ]

htmlhelp_basename

string conf.htmlhelp_basename = 'ELTICSdoc'

intersphinx_cache_limit

int conf.intersphinx_cache_limit = 0

intersphinx_mapping

dictionary conf.intersphinx_mapping

Initial value:

=  {
    'DevGuide': ('http://www.eso.org/~eltmgr/ICS/documents/DeveloperGuide/build/html', None),
    'radManual': ('http://www.eso.org/~eltmgr/ICS/documents/RAD/sphinx_doc/html', None),
    'etrManual': ('http://www.eso.org/~eltmgr/ICS/documents/ETR/sphinx_doc/html', None),
    'seqManual': ('http://www.eso.org/~eltmgr/ICS/documents/SEQ/sphinx_doc/html', None)
}

language

conf.language = None

latex_attrs

conf.latex_attrs

Initial value:

=  dict(
    pdm_version = '2',
    release_date = '2021-05-31',
    owner=author,
    validated_pm='Kornweibel, Nick',
    validated_se='González Herrera, Juan Carlos',
    validated_pe='Biancat Marchet, Fabio',
    approved_pgm='Tamai, Roberto')

Update for each release:

latex_documents

list conf.latex_documents

Initial value:

=  [
   #(master_doc, 'ELTICSdoc.tex', 'ELT ICS Framework documentation', 'ELT ICS Group', 'howto',False),
    ('index','FCF-UserManual.tex', 'IFW FCF User Manual', author, 'manual',False),
]

latex_elements

dictionary conf.latex_elements

latex_engine

string conf.latex_engine = 'pdflatex'

latex_show_urls

string conf.latex_show_urls = 'footnote'

man_pages

list conf.man_pages

Initial value:

=  [
    (master_doc, 'elticsdoc', 'ELT ICS Framework documentation',
     [author], 1)
]

master_doc

string conf.master_doc = 'index'

project

string conf.project = 'ELT ICS Function Control Framework'

pygments_style

string conf.pygments_style = 'sphinx'

release

string conf.release = version

source_suffix

string conf.source_suffix = '.rst'

texinfo_documents

list conf.texinfo_documents

Initial value:

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

todo_include_todos

bool conf.todo_include_todos = True

version

string conf.version = '5.0.0-pre2'