conf Namespace Reference

Variables
list	extensions
dictionary	autodoc_default_options
list	templates_path = ['_templates']
string	source_suffix = '.rst'
string	master_doc = 'index'
string	project = 'Sequencer Manual'
string	copyright = ' 2021 ESO - European Southern Observatory'
string	homepage = r'https://gitlab.eso.org/ifw/seq'
string	author = 'Muñoz, Iván'
	Update for each release: More...
	latex_attrs
string	version = '4.0.0-pre3'
string	release = version
	language = None
list	exclude_patterns = []
string	pygments_style = 'sphinx'
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 = []
dictionary	html_context = {}
bool	html_show_sphinx = False
string	htmlhelp_basename = 'ELTICSseq'
string	latex_engine = 'pdflatex'
dictionary	latex_elements
string	latex_show_urls = 'footnote'
list	latex_documents
list	man_pages
list	texinfo_documents
dictionary	intersphinx_mapping = {'python': ('https://docs.python.org/3', None)}
bool	todo_include_todos = True
bool	auto_summary = True
bool	autosummary_generate = True
dictionary	html_sidebars

Variable Documentation

author

string conf.author = 'Muñoz, Iván'

Update for each release:

auto_summary

bool conf.auto_summary = True

autodoc_default_options

dictionary conf.autodoc_default_options

Initial value:

=  {
    'show-inheritance': False,
    'members': True,
    'member-order': 'bysource',
    'undoc-members': False,
    'exclude-members': '__weakref__'
}

autosummary_generate

bool conf.autosummary_generate = True

copyright

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

exclude_patterns

list conf.exclude_patterns = []

extensions

list conf.extensions

Initial value:

=  [
    'sphinx_eso_theme',
    'sphinx.ext.autodoc',
 #   'sphinx.ext.autosummary',
    'sphinx.ext.intersphinx',
    'sphinx.ext.todo',
    'sphinx.ext.ifconfig',
    'sphinx.ext.viewcode',
    'sphinx.ext.napoleon',
    # 'sphinxcontrib.zopeext.autointerface',
    # diagrams
    'sphinx.ext.graphviz',
    # 'sphinxcontrib.blockdiag',
    # 'sphinxcontrib.seqdiag',
]

homepage

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

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_sidebars

dictionary conf.html_sidebars

Initial value:

=  {
    '**': [
        'about.html',
        'navigation.html',
        'relations.html',  # needs 'show_related': True theme option to display
        'searchbox.html',
        'donate.html',
    ]
}

html_static_path

list conf.html_static_path = []

html_theme

string conf.html_theme = 'sphinx_eso_theme'

html_theme_path

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

htmlhelp_basename

string conf.htmlhelp_basename = 'ELTICSseq'

intersphinx_mapping

dictionary conf.intersphinx_mapping = {'python': ('https://docs.python.org/3', None)}

language

conf.language = None

latex_attrs

conf.latex_attrs

Initial value:

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

latex_documents

list conf.latex_documents

Initial value:

=  [
   (master_doc, 'ELTICSseq.tex', 'ELT ICS Framework - Sequencer - User Manual', 'ELT ICS Group', 'howto',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_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, 'seqlib', 'seqlib Documentation',
     [author], 1)
]

master_doc

string conf.master_doc = 'index'

project

string conf.project = 'Sequencer Manual'

pygments_style

string conf.pygments_style = 'sphinx'

release

string conf.release = version

source_suffix

string conf.source_suffix = '.rst'

templates_path

list conf.templates_path = ['_templates']

texinfo_documents

list conf.texinfo_documents

Initial value:

=  [
    (master_doc, 'seqlib', 'seqlib Documentation',
     author, 'seqlib', 'One line description of project.',
     'Miscellaneous'),
]

todo_include_todos

bool conf.todo_include_todos = True

version

string conf.version = '4.0.0-pre3'