conf Namespace Reference

Variables
str	project = 'Cryo HMI Framework User Manual'
str	copyright = '2024 ESO - European Southern Observatory'
str	author = 'Diego del Valle'
str	version = '1.1.0'
str	release = version
list	extensions
str	source_suffix = '.rst'
str	master_doc = 'index'
str	language = 'en'
list	exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
str	homepage = r'https://gitlab.eso.org/ifw/ifw-ll'
	TODO Add this.
	latex_attrs
	Update for each release (These values come from the PDM):
str	pygments_style = 'default'
bool	todo_include_todos = True
str	html_theme = 'sphinx_eso_theme'
list	html_theme_path = []
bool	html_show_sourcelink = False
bool	html_copy_source = False
dict	html_context = {}
bool	html_show_sphinx = False
str	htmlhelp_basename = 'cryo_framework'
str	latex_engine = 'pdflatex'
dict	latex_elements
str	latex_show_urls = 'footnote'
str	latex_theme = 'howto'
list	latex_documents
list	man_pages
list	texinfo_documents
bool	numfig = True
str	rst_prolog
list	html_static_path = ['_static']
list	html_css_files

Variable Documentation

author

str conf.author = 'Diego del Valle'

copyright

str conf.copyright = '2024 ESO - European Southern Observatory'

exclude_patterns

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

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',
    'sphinx_eso_theme',
]

homepage

str conf.homepage = r'https://gitlab.eso.org/ifw/ifw-ll'

TODO Add this.

html_context

dict conf.html_context = {}

html_copy_source

bool conf.html_copy_source = False

html_css_files

list conf.html_css_files

Initial value:

=  [
    'css/hacks.css',
]

html_show_sourcelink

bool conf.html_show_sourcelink = False

html_show_sphinx

bool conf.html_show_sphinx = False

html_static_path

list conf.html_static_path = ['_static']

html_theme

str conf.html_theme = 'sphinx_eso_theme'

html_theme_path

list conf.html_theme_path = []

htmlhelp_basename

str conf.htmlhelp_basename = 'cryo_framework'

language

str conf.language = 'en'

latex_attrs

conf.latex_attrs

Initial value:

=  dict(
    pdm_version = '1',
    release_date = '2024-08-01',
    owner='Del Valle, Diego',
    validated_wpm='Kiekebusch, Mario',
    approved_pm='Kiekebusch, Mario')

Update for each release (These values come from the PDM):

latex_documents

list conf.latex_documents

Initial value:

=  [
    (master_doc, 'cryo_framework.tex', project, author, latex_theme, False),
]

latex_elements

dict conf.latex_elements

latex_engine

str conf.latex_engine = 'pdflatex'

latex_show_urls

str conf.latex_show_urls = 'footnote'

latex_theme

str conf.latex_theme = 'howto'

man_pages

list conf.man_pages

Initial value:

=  [
    (master_doc, 'cryo_framework', project,
     [author], 1)
]

master_doc

str conf.master_doc = 'index'

numfig

bool conf.numfig = True

project

str conf.project = 'Cryo HMI Framework User Manual'

pygments_style

str conf.pygments_style = 'default'

release

str conf.release = version

rst_prolog

str conf.rst_prolog

Initial value:

=  """
.. include:: <s5defs.txt>
 
"""

source_suffix

str conf.source_suffix = '.rst'

texinfo_documents

list conf.texinfo_documents

Initial value:

=  [
    (master_doc, 'cryo_framework', project,
     author, '', 'Cryo HMI Framework User Manual',
     'Miscellaneous'),
]

todo_include_todos

bool conf.todo_include_todos = True

version

str conf.version = '1.1.0'