conf Namespace Reference

Functions
def	setup (app)

Variables
list	extensions
string	master_doc = 'index'
string	project = 'metadaqif documentation'
string	copyright = ' 2022 ESO - European Southern Observatory'
string	homepage = r'https://gitlab.eso.org/ecs/ecs-interfaces/-/tree/master/metadaq'
string	rst_prolog
string	version = '1.0.0'
bool	prerelease = True
string	release = version
	rev
string	suffix = "+git.%s" % rev
list	exclude_patterns = []
string	pygments_style = 'default'
string	html_theme = 'sphinx_eso_theme'
bool	html_show_sourcelink = False
bool	html_copy_source = True
bool	html_show_sphinx = False

Function Documentation

setup()

def conf.setup

(

app

)

Variable Documentation

copyright

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

exclude_patterns

list conf.exclude_patterns = []

extensions

list conf.extensions

Initial value:

=  [
    'sphinx.ext.ifconfig',
    'sphinx.ext.graphviz',
    'sphinx_eso_theme']

homepage

string conf.homepage = r'https://gitlab.eso.org/ecs/ecs-interfaces/-/tree/master/metadaq'

html_copy_source

bool conf.html_copy_source = True

html_show_sourcelink

bool conf.html_show_sourcelink = False

html_show_sphinx

bool conf.html_show_sphinx = False

html_theme

string conf.html_theme = 'sphinx_eso_theme'

master_doc

string conf.master_doc = 'index'

prerelease

bool conf.prerelease = True

project

string conf.project = 'metadaqif documentation'

pygments_style

string conf.pygments_style = 'default'

release

string conf.release = version

rev

conf.rev

Initial value:

=  subprocess.run(["git", "rev-parse", "--short=5", "HEAD"],
                             stdout=subprocess.PIPE).stdout.decode("utf-8")

rst_prolog

string conf.rst_prolog

Initial value:

=  """
.. |daq| replace:: *Data Acquisition*
.. |dp| replace:: *Data Product*
"""

suffix

string conf.suffix = "+git.%s" % rev

version

string conf.version = '1.0.0'