USRP Hardware Driver and USRP Manual  Version: 4.6.0.0
UHD and USRP Manual
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'
 
 language = None
 
list exclude_patterns = []
 
 pygments_style = None
 
string html_theme = 'alabaster'
 
list html_static_path = ['_static']
 
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:
1 = [
2 ]

◆ html_extra_path

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

◆ html_static_path

list conf.html_static_path = ['_static']

◆ html_theme

string conf.html_theme = 'alabaster'

◆ htmlhelp_basename

string conf.htmlhelp_basename = 'UHDdoc'

◆ language

conf.language = None

◆ latex_documents

list conf.latex_documents
Initial value:
1 = [
2  (master_doc, 'UHD.tex', 'UHD Documentation',
3  'Ettus Research, an NI Brand', 'manual'),
4 ]

◆ latex_elements

dictionary conf.latex_elements
Initial value:
1 = {
2  # The paper size ('letterpaper' or 'a4paper').
3  #
4  # 'papersize': 'letterpaper',
5 
6  # The font size ('10pt', '11pt' or '12pt').
7  #
8  # 'pointsize': '10pt',
9 
10  # Additional stuff for the LaTeX preamble.
11  #
12  # 'preamble': '',
13 
14  # Latex figure (float) alignment
15  #
16  # 'figure_align': 'htbp',
17 }

◆ man_pages

list conf.man_pages
Initial value:
1 = [
2  (master_doc, 'uhd', 'UHD Documentation',
3  [author], 1)
4 ]

◆ 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:
1 = [
2  (master_doc, 'UHD', 'UHD Documentation',
3  author, 'UHD', 'One line description of project.',
4  'Miscellaneous'),
5 ]

◆ version

string conf.version = ''