conf Namespace Reference

Variables
list	extensions
list	templates_path = ['_templates']
string	source_suffix = '.rst'
string	master_doc = 'index'
string	project = 'Sequencer Manual'
string	copyright = ' 2020 ESO - European Southern Observatory'
string	homepage = r'https://gitlab.eso.org/ifw/seq'
string	author = 'Muñoz, Iván'
	Update for each release: More...
tuple	latex_attrs
string	version = '1.1.0'
string	release = '1.1.0'
	language = None
list	exclude_patterns = []
string	pygments_style = 'sphinx'
string	html_theme = 'sphinx_eso_theme'
list	html_theme_path = ['_themes/', ]
	html_show_sourcelink = False
	html_copy_source = False
list	html_static_path = []
dictionary	html_context = {}
	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 = {'https://docs.python.org/': None}
	todo_include_todos = True
	auto_summary = True
	autosummary_generate = True
dictionary	html_sidebars

Variable Documentation

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

Update for each release:

conf.auto_summary = True

conf.autosummary_generate = True

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

list conf.exclude_patterns = []

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

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

dictionary conf.html_context = {}

conf.html_copy_source = False

conf.html_show_sourcelink = False

conf.html_show_sphinx = False

dictionary conf.html_sidebars

Initial value:

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

list conf.html_static_path = []

string conf.html_theme = 'sphinx_eso_theme'

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

string conf.htmlhelp_basename = 'ELTICSseq'

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

conf.language = None

tuple conf.latex_attrs

Initial value:

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

list conf.latex_documents

Initial value:

= [
   (master_doc, 'ELTICSseq.tex', 'ELT ICS Framework - Sequencer - User Manual', 'ELT ICS Group', 'howto',False),
]

dictionary conf.latex_elements

string conf.latex_engine = 'pdflatex'

string conf.latex_show_urls = 'footnote'

list conf.man_pages

Initial value:

= [
    (master_doc, 'seqlib', 'seqlib Documentation',
     [author], 1)
]

string conf.master_doc = 'index'

string conf.project = 'Sequencer Manual'

string conf.pygments_style = 'sphinx'

string conf.release = '1.1.0'

string conf.source_suffix = '.rst'

list conf.templates_path = ['_templates']

list conf.texinfo_documents

Initial value:

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

conf.todo_include_todos = True

string conf.version = '1.1.0'