conf Namespace Reference

Variables
string	project = 'RTC Toolkit'
string	copyright = ' 2021 ESO - European Southern Observatory'
string	author = 'RTC Toolkit Project Team'
list	extensions
list	templates_path = ['_templates']
list	exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
string	homepage = r'https://gitlab.eso.org/rtctk/rtctk'
	latex_attrs
	Update for each release: More...
string	version = '0.1.0-alpha'
string	release = '0.1.0-alpha'
	language = None
string	pygments_style = 'default'
bool	todo_include_todos = True
bool	numfig = 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 = 'ELTRTCTKdoc'
string	latex_engine = 'pdflatex'
dictionary	latex_elements
string	latex_show_urls = 'footnote'
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
int	intersphinx_cache_limit = 0
dictionary	extlinks

Variable Documentation

author

string conf.author = 'RTC Toolkit Project Team'

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 = ['_build', 'Thumbs.db', '.DS_Store']

extensions

list conf.extensions

Initial value:

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

extlinks

dictionary conf.extlinks

Initial value:

=  {
    #'doxydoc': ('http://www.eso.org/~eeltmgr/.../%s', ''),
    'esogitlab': ('https://gitlab.eso.org/%s', ''),
    'esojira': ('https://jira.eso.org/%s', ''),
}

homepage

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

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 = 'ELTRTCTKdoc'

intersphinx_cache_limit

int conf.intersphinx_cache_limit = 0

intersphinx_mapping

dictionary conf.intersphinx_mapping

Initial value:

=  {
}

language

conf.language = None

latex_attrs

conf.latex_attrs

Initial value:

=  dict(
    pdm_version = 'TBD',
    release_date = 'TBD',
    owner=author,
    validated_pm='TBD',
    validated_se='TBD',
    validated_pe='TBD',
    approved_pgm='TBD')

Update for each release:

latex_elements

dictionary conf.latex_elements

latex_engine

string conf.latex_engine = 'pdflatex'

latex_show_urls

string conf.latex_show_urls = 'footnote'

man_pages

list conf.man_pages

Initial value:

=  [
    ('RTCTK', 'elticsdoc', 'ELT RTCTK Framework documentation',
     [author], 1)
]

numfig

bool conf.numfig = True

project

string conf.project = 'RTC Toolkit'

pygments_style

string conf.pygments_style = 'default'

release

string conf.release = '0.1.0-alpha'

templates_path

list conf.templates_path = ['_templates']

texinfo_documents

list conf.texinfo_documents

Initial value:

=  [
    ('RTCTK', 'ELTRTCTKdoc', 'ELT RTCTK Framework documentation',
     author, 'ELTRTCTKdoc', 'One line description of project.',
     'Miscellaneous'),
]

todo_include_todos

bool conf.todo_include_todos = True

version

string conf.version = '0.1.0-alpha'