conf Namespace Reference

Variables
string	project = 'UHD'
string	copyright = '2022, Ettus Research, an NI Brand'
string	author = 'Ettus Research, an NI Brand'
string	version = ''
string	release = ''
list	extensions
list	templates_path = ['_templates']
string	source_suffix = '.rst'
string	master_doc = 'index'
string	language = 'en'
list	exclude_patterns = []
	pygments_style = None
string	html_theme = 'alabaster'
string	htmlhelp_basename = 'UHDdoc'
dictionary	latex_elements
list	latex_documents
list	man_pages
list	texinfo_documents
string	epub_title = project
list	epub_exclude_files = ['search.html']
	shell
list	html_extra_path = [f'{_doxy_dir}/docs/doxygen/html']

Variable Documentation

author

string conf.author = 'Ettus Research, an NI Brand'

copyright

string conf.copyright = '2022, Ettus Research, an NI Brand'

epub_exclude_files

list conf.epub_exclude_files = ['search.html']

epub_title

string conf.epub_title = project

exclude_patterns

list conf.exclude_patterns = []

extensions

list conf.extensions

Initial value:

=  [
]

html_extra_path

list conf.html_extra_path = [f'{_doxy_dir}/docs/doxygen/html']

html_theme

string conf.html_theme = 'alabaster'

htmlhelp_basename

string conf.htmlhelp_basename = 'UHDdoc'

language

string conf.language = 'en'

latex_documents

list conf.latex_documents

Initial value:

=  [
    (master_doc, 'UHD.tex', 'UHD Documentation',
     'Ettus Research, an NI Brand', 'manual'),
]

latex_elements

dictionary conf.latex_elements

Initial value:

=  {
    # The paper size ('letterpaper' or 'a4paper').
    #
    # 'papersize': 'letterpaper',
 
    # The font size ('10pt', '11pt' or '12pt').
    #
    # 'pointsize': '10pt',
 
    # Additional stuff for the LaTeX preamble.
    #
    # 'preamble': '',
 
    # Latex figure (float) alignment
    #
    # 'figure_align': 'htbp',
}

man_pages

list conf.man_pages

Initial value:

=  [
    (master_doc, 'uhd', 'UHD Documentation',
     [author], 1)
]

master_doc

string conf.master_doc = 'index'

project

string conf.project = 'UHD'

pygments_style

conf.pygments_style = None

release

string conf.release = ''

shell

conf.shell

source_suffix

string conf.source_suffix = '.rst'

templates_path

list conf.templates_path = ['_templates']

texinfo_documents

list conf.texinfo_documents

Initial value:

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

version

string conf.version = ''