conf Namespace Reference

Functions
def	setup (app)

Variables
list	extensions
string	source_suffix = '.rst'
string	master_doc = 'index'
list	exclude_patterns = ['src/dpm.rst']
bool	numfig = True
string	project = 'IFW Data Acquisition User Manual'
string	copyright = ' 2021 ESO - European Southern Observatory'
string	homepage = r'https://gitlab.eso.org/ifw/ifw-hl'
string	rst_prolog
string	author = 'Rosenquist, Calle'
	Update for each release: More...
	latex_attrs
string	version = '1.0.0'
bool	prerelease = False
string	release = '1.0.0'
string	ifw_release = '3.0.0'
	rev
string	suffix = "+git.%s" % rev
	language = None
string	pygments_style = 'default'
bool	todo_include_todos = True
int	plantuml_batch_size = 100
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	latex_toplevel_sectioning = 'section'
	latex_docclass = dict(manual='article')
dictionary	latex_elements
string	latex_show_urls = 'footnote'
list	latex_documents

Function Documentation

setup()

def conf.setup

(

app

)

Definition at line 233 of file conf.py.

Variable Documentation

author

string conf.author = 'Rosenquist, Calle'

Update for each release:

Definition at line 49 of file conf.py.

copyright

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

Definition at line 28 of file conf.py.

exclude_patterns

list conf.exclude_patterns = ['src/dpm.rst']

Definition at line 22 of file conf.py.

extensions

list conf.extensions

Initial value:

=  ['sphinx.ext.intersphinx',
    'sphinx.ext.ifconfig',
    'sphinx.ext.graphviz',
    'sphinx.ext.mathjax',
#    'sphinxcontrib.plantuml',
    'sphinx_eso_theme']

Definition at line 11 of file conf.py.

homepage

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

Definition at line 29 of file conf.py.

html_context

dictionary conf.html_context = {}

Definition at line 126 of file conf.py.

html_copy_source

bool conf.html_copy_source = False

Definition at line 109 of file conf.py.

html_show_sourcelink

bool conf.html_show_sourcelink = False

Definition at line 108 of file conf.py.

html_show_sphinx

bool conf.html_show_sphinx = False

Definition at line 129 of file conf.py.

html_static_path

list conf.html_static_path = ['_static']

Definition at line 120 of file conf.py.

html_theme

string conf.html_theme = 'sphinx_eso_theme'

Definition at line 106 of file conf.py.

html_theme_path

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

Definition at line 107 of file conf.py.

ifw_release

string conf.ifw_release = '3.0.0'

Definition at line 68 of file conf.py.

language

conf.language = None

Definition at line 86 of file conf.py.

latex_attrs

conf.latex_attrs

Initial value:

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

Definition at line 50 of file conf.py.

latex_docclass

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

Definition at line 137 of file conf.py.

latex_documents

list conf.latex_documents

Initial value:

=  [
   ('index-latex', 'ELT_ICS_Framework_-_Data_Acquisition_-_User_Manual.tex',
    'ELT ICS Framework - Data Acquisition - User Manual',
    author, 'manual', False),
]

Definition at line 226 of file conf.py.

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, ifw_release=ifw_release, author=author, homepage=homepage),
    'tableofcontents': r'\tableofcontents\newpage',
}

Definition at line 138 of file conf.py.

latex_show_urls

string conf.latex_show_urls = 'footnote'

Definition at line 221 of file conf.py.

latex_toplevel_sectioning

string conf.latex_toplevel_sectioning = 'section'

Definition at line 136 of file conf.py.

master_doc

string conf.master_doc = 'index'

Definition at line 21 of file conf.py.

numfig

bool conf.numfig = True

Definition at line 24 of file conf.py.

plantuml_batch_size

int conf.plantuml_batch_size = 100

Definition at line 99 of file conf.py.

prerelease

bool conf.prerelease = False

Definition at line 65 of file conf.py.

project

string conf.project = 'IFW Data Acquisition User Manual'

Definition at line 26 of file conf.py.

pygments_style

string conf.pygments_style = 'default'

Definition at line 94 of file conf.py.

release

string conf.release = '1.0.0'

Definition at line 67 of file conf.py.

rev

conf.rev

Initial value:

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

Definition at line 71 of file conf.py.

rst_prolog

string conf.rst_prolog

Initial value:

=  """
.. |daq| replace:: *Data Acquisition*
.. |daqs| replace:: *Data Acquisitions*
.. |dp| replace:: *Data Product*
.. |ocm| replace:: :ref:`OCM<ocm>`
.. |dpm| replace:: *DPM*
.. |olas| replace:: :ref:`OLAS<def-olas>`
.. |configpath| replace:: :term:`Config Path`
.. |recif| replace:: :term:`recif`
.. |ocmserver| replace:: :ref:`ocmServer <ocmServer>`
.. |ocmserverctl| replace:: :ref:`ocmServerCtl <ocmServerCtl>`
"""

Definition at line 34 of file conf.py.

source_suffix

string conf.source_suffix = '.rst'

Definition at line 18 of file conf.py.

suffix

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

Definition at line 73 of file conf.py.

todo_include_todos

bool conf.todo_include_todos = True

Definition at line 97 of file conf.py.

version

string conf.version = '1.0.0'

Definition at line 64 of file conf.py.