conf Namespace Reference

Variables
string	author = 'Clearpath Robotics'
string	copyright = '2023, Clearpath Robotics'
list	epub_exclude_files = ['search.html']
string	epub_title = project
list	exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
list	extensions
list	html_static_path = ['_static']
string	html_theme = 'alabaster'
string	htmlhelp_basename = 'clearpath_onav_api_examples_libdoc'
	language = None
list	latex_documents
dictionary	latex_elements
list	man_pages
string	master_doc = 'index'
string	project = 'clearpath_onav_api_examples_lib'
	pygments_style = None
string	release = ''
string	source_suffix = '.rst'
list	templates_path = ['_templates']
list	texinfo_documents
string	version = ''

Variable Documentation

author

string conf.author = 'Clearpath Robotics'

Definition at line 24 of file conf.py.

copyright

string conf.copyright = '2023, Clearpath Robotics'

Definition at line 23 of file conf.py.

epub_exclude_files

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

Definition at line 176 of file conf.py.

epub_title

string conf.epub_title = project

Definition at line 164 of file conf.py.

exclude_patterns

list conf.exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']

Definition at line 69 of file conf.py.

extensions

list conf.extensions

Initial value:

=  [
    'sphinx.ext.autodoc',
    'sphinx.ext.viewcode',
    'sphinx.ext.napoleon'
]

Definition at line 41 of file conf.py.

html_static_path

list conf.html_static_path = ['_static']

Definition at line 91 of file conf.py.

html_theme

string conf.html_theme = 'alabaster'

Definition at line 80 of file conf.py.

htmlhelp_basename

string conf.htmlhelp_basename = 'clearpath_onav_api_examples_libdoc'

Definition at line 107 of file conf.py.

language

conf.language = None

Definition at line 64 of file conf.py.

latex_documents

list conf.latex_documents

Initial value:

=  [
    (master_doc, 'clearpath_onav_api_examples_lib.tex', 'clearpath\\_onav\\_api\\_examples\\_lib Documentation',
     'Clearpath Robotics', 'manual'),
]

Definition at line 133 of file conf.py.

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

Definition at line 112 of file conf.py.

man_pages

list conf.man_pages

Initial value:

=  [
    (master_doc, 'clearpath_onav_api_examples_lib', 'clearpath_onav_api_examples_lib Documentation',
     [author], 1)
]

Definition at line 143 of file conf.py.

master_doc

string conf.master_doc = 'index'

Definition at line 57 of file conf.py.

project

string conf.project = 'clearpath_onav_api_examples_lib'

Definition at line 22 of file conf.py.

pygments_style

conf.pygments_style = None

Definition at line 72 of file conf.py.

release

string conf.release = ''

Definition at line 29 of file conf.py.

source_suffix

string conf.source_suffix = '.rst'

Definition at line 54 of file conf.py.

templates_path

list conf.templates_path = ['_templates']

Definition at line 48 of file conf.py.

texinfo_documents

list conf.texinfo_documents

Initial value:

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

Definition at line 154 of file conf.py.

version

string conf.version = ''

Definition at line 27 of file conf.py.