conf Namespace Reference

Variables
list	extensions
string	source_suffix = '.rst'
string	master_doc = 'index'
string	project = 'Extensible Test Runner Manual'
string	copyright = ' 2021 ESO - European Southern Observatory'
string	homepage = r'https://gitlab.eso.org/ifw/etr'
string	author = 'Rosenquist, Calle'
	Update for each release: More...
	latex_attrs
string	version = "3.1.1"
string	release = version
	language = None
list	exclude_patterns = []
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
list	html_static_path = ['_static']
dictionary	html_context = {}
bool	html_show_sphinx = False
string	htmlhelp_basename = 'ELTICSetr'
string	latex_toplevel_sectioning = 'section'
	latex_docclass = dict(manual='article')
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 = {'https://docs.python.org/': None}

Variable Documentation

author

string conf.author = 'Rosenquist, Calle'

Update for each release:

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

exclude_patterns

list conf.exclude_patterns = []

extensions

list conf.extensions

Initial value:

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

homepage

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

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_static_path

list conf.html_static_path = ['_static']

html_theme

string conf.html_theme = 'sphinx_eso_theme'

html_theme_path

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

htmlhelp_basename

string conf.htmlhelp_basename = 'ELTICSetr'

intersphinx_mapping

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

language

conf.language = None

latex_attrs

conf.latex_attrs

Initial value:

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

latex_docclass

conf.latex_docclass = dict(manual='article')

latex_documents

list conf.latex_documents

Initial value:

=  [
   ('index_latex', 'ELT_ICS_Framework_-_Test_Framework_-_User_Manual.tex',
    'ELT ICS Framework - Test Framework - User Manual',
    'ELT ICS Group', 'manual', False),
]

latex_elements

dictionary conf.latex_elements

Initial value:

=  {
    # The paper size ('letterpaper' or 'a4paper').
    #
    'papersize': 'a4paper',
 
    # The font size ('10pt', '11pt' or '12pt').
    #
    'pointsize': '11pt',
 
    # Additional stuff for the LaTeX preamble.
    #
    'preamble':
         % latex_attrs,
    # Latex figure (float) alignment
    #
    # 'figure_align': 'htbp',
    'sphinxsetup': \
        'hmargin={0.7in,0.7in}, vmargin={1in,1in}, \
        verbatimwithframe=true, \
        OuterLinkColor={rgb}{0,0,0.6}, \
        InnerLinkColor={rgb}{0,0,0}, \
        warningBorderColor={rgb}{0.8,0,0}, \
        cautionBorderColor={rgb}{1,0.8,0}, \
        TitleColor={rgb}{0,0,0}',
    'printindex': r'\newpage',
    'maketitle':  % dict(release=release, author=author, homepage=homepage),
    'tableofcontents': r'\tableofcontents\newpage',
}

latex_show_urls

string conf.latex_show_urls = 'footnote'

latex_toplevel_sectioning

string conf.latex_toplevel_sectioning = 'section'

man_pages

list conf.man_pages

Initial value:

=  [
    (master_doc, 'elticsdeveloperguide', 'ELT ICS etr Manual',
     [author], 1)
]

master_doc

string conf.master_doc = 'index'

project

string conf.project = 'Extensible Test Runner Manual'

release

string conf.release = version

source_suffix

string conf.source_suffix = '.rst'

texinfo_documents

list conf.texinfo_documents

Initial value:

=  [
    (master_doc, 'ELTICSetr', 'ELT ICS etr Manual',
     author, 'ELTICSetr', 'One line description of project.',
     'Miscellaneous'),
]

todo_include_todos

bool conf.todo_include_todos = True

version

string conf.version = "3.1.1"