conf Namespace Reference

Variables
str	project = 'ELT Developing Software Guide'
str	copyright = ' 2026 ESO - European Southern Observatory'
str	author = 'Pellegrin, Federico'
str	version = '4.0'
str	release = version
list	extensions
list	templates_path = ['_templates']
list	exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
str	pygments_style = 'default'
bool	todo_include_todos = True
bool	numfig = True
str	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']
dict	html_context = {}
bool	html_show_sphinx = False
str	latex_homepage = r'https://gitlab.eso.org/eltdev/eltdev-docs'
str	latex_toplevel_sectioning = 'section'
	latex_docclass = dict(manual='article')
	latex_attrs
dict	latex_elements
str	latex_show_urls = 'footnote'
list	latex_documents
list	man_pages
list	texinfo_documents
str	epub_title = project
str	epub_author = author
str	epub_publisher = author
str	epub_copyright = copyright
list	epub_exclude_files = ['search.html']
dict	intersphinx_mapping = {'https://docs.python.org/': None}

Variable Documentation

author

str conf.author = 'Pellegrin, Federico'

copyright

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

epub_author

str conf.epub_author = author

epub_copyright

str conf.epub_copyright = copyright

epub_exclude_files

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

epub_publisher

str conf.epub_publisher = author

epub_title

str conf.epub_title = project

exclude_patterns

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

extensions

list conf.extensions

Initial value:

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

html_context

dict 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

str conf.html_theme = 'sphinx_eso_theme'

html_theme_path

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

intersphinx_mapping

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

latex_attrs

conf.latex_attrs

Initial value:

=  dict(
    pdm_version='4.0',
    release_date='2026-08-31',
    owner=author,
    validated_pm='Pellegrin, Federico',
    validated_se='Kurlandczyk, Hervé',
    validated_pe='Kornweibel, Nick',
    approved_pgm='Kornweibel, Nick')

latex_docclass

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

latex_documents

list conf.latex_documents

Initial value:

=  [
    ('index', 'ELT_Developing_-_Software_-_Guide.tex',
            'ELT Developing Software Guide',
            'ELT DevEnv Group', 'manual', False),
]

latex_elements

dict 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=latex_homepage),
    'tableofcontents': r'\tableofcontents\newpage',
}

latex_homepage

str conf.latex_homepage = r'https://gitlab.eso.org/eltdev/eltdev-docs'

latex_show_urls

str conf.latex_show_urls = 'footnote'

latex_toplevel_sectioning

str conf.latex_toplevel_sectioning = 'section'

man_pages

list conf.man_pages

Initial value:

=  [
    ('index', 'eltdevelopingsoftwareguide', 'ELT Developing Software Guide', [author], 1)
]

numfig

bool conf.numfig = True

project

str conf.project = 'ELT Developing Software Guide'

pygments_style

str conf.pygments_style = 'default'

release

str conf.release = version

templates_path

list conf.templates_path = ['_templates']

texinfo_documents

list conf.texinfo_documents

Initial value:

=  [
    ('index', 'ELTDevSwGuide', 'ELT Developing Software Guide',
            author, 'ELTDevSwGuide', 'One line description of project.',
            'Miscellaneous'),
]

todo_include_todos

bool conf.todo_include_todos = True

version

str conf.version = '4.0'