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']
int	PY3 = 3
int	string_types = str if PY3 else basestring
string	SUFFIX = source_suffix
dictionary	context
dictionary	html_baseurl = context['canonical_url']
dictionary	html_context = context
string	readthedocs_vcs_url = 'None'
string	readthedocs_build_url = 'https://readthedocs.org/projects/uhd/builds/24845249/'
string	project_language = 'en'
	language_user = globals().get('language', None)
	latex_engine_user = globals().get('latex_engine', None)
	latex_elements_user = globals().get('latex_elements', None)
bool	latex_use_xindy = False
	chinese
	japanese
string	latex_engine = latex_engine_user or 'xelatex'
dictionary	latex_elements_rtd

Variable Documentation

author

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

chinese

conf.chinese

Initial value:

=  any([
    language_user in ('zh_CN', 'zh_TW'),
    project_language in ('zh_CN', 'zh_TW'),
])

context

dictionary conf.context

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

conf.exclude_patterns = []

extensions

list conf.extensions

Initial value:

=  [
]

html_baseurl

dictionary conf.html_baseurl = context['canonical_url']

html_context

dictionary conf.html_context = context

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

conf.html_theme = 'alabaster'

htmlhelp_basename

string conf.htmlhelp_basename = 'UHDdoc'

japanese

conf.japanese

Initial value:

=  any([
    language_user == 'ja',
    project_language == 'ja',
])

language

conf.language = None

language_user

conf.language_user = globals().get('language', None)

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',
}

latex_elements_rtd

dictionary conf.latex_elements_rtd

Initial value:

=  {
        'preamble': '\\usepackage[UTF8]{ctex}\n',
    }

latex_elements_user

conf.latex_elements_user = globals().get('latex_elements', None)

latex_engine

string conf.latex_engine = latex_engine_user or 'xelatex'

latex_engine_user

conf.latex_engine_user = globals().get('latex_engine', None)

latex_use_xindy

bool conf.latex_use_xindy = False

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'

project_language

string conf.project_language = 'en'

PY3

int conf.PY3 = 3

pygments_style

conf.pygments_style = None

readthedocs_build_url

string conf.readthedocs_build_url = 'https://readthedocs.org/projects/uhd/builds/24845249/'

readthedocs_vcs_url

string conf.readthedocs_vcs_url = 'None'

release

string conf.release = ''

shell

conf.shell

source_suffix

string conf.source_suffix = '.rst'

string_types

int conf.string_types = str if PY3 else basestring

SUFFIX

string conf.SUFFIX = source_suffix

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