conf Namespace Reference

Variables
bool	add_module_names = False
string	author = "MoveIt maintainer team"
string	autoclass_content = "both"
bool	autodoc_inherit_docstrings = True
bool	autosummary_generate = True
bool	autosummary_imported_members = True
string	copyright = "2021, MoveIt maintainer team"
list	epub_exclude_files = ["search.html"]
string	epub_title = project
list	exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "_templates"]
list	extensions
tuple	html_show_sourcelink
list	html_static_path = ["_static"]
string	html_theme = "sphinx_rtd_theme"
string	htmlhelp_basename = "moveit_coredoc"
dictionary	intersphinx_mapping = {"https://docs.python.org/3": None}
	language = None
list	latex_documents
dictionary	latex_elements
list	man_pages = [(master_doc, "moveit_core", "moveit_core Documentation", [author], 1)]
string	master_doc = "index"
string	project = "moveit.core"
	pygments_style = None
string	release = ""
bool	set_type_checking_flag = True
string	source_suffix = ".rst"
list	templates_path = ["_templates"]
list	texinfo_documents
string	version = ""

Variable Documentation

add_module_names

bool conf.add_module_names = False

Definition at line 60 of file conf.py.

author

string conf.author = "MoveIt maintainer team"

Definition at line 24 of file conf.py.

autoclass_content

string conf.autoclass_content = "both"

Definition at line 52 of file conf.py.

autodoc_inherit_docstrings

bool conf.autodoc_inherit_docstrings = True

Definition at line 58 of file conf.py.

autosummary_generate

bool conf.autosummary_generate = True

Definition at line 50 of file conf.py.

autosummary_imported_members

bool conf.autosummary_imported_members = True

Definition at line 51 of file conf.py.

copyright

string conf.copyright = "2021, MoveIt maintainer team"

Definition at line 23 of file conf.py.

epub_exclude_files

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

Definition at line 192 of file conf.py.

epub_title

string conf.epub_title = project

Definition at line 180 of file conf.py.

exclude_patterns

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

Definition at line 85 of file conf.py.

extensions

list conf.extensions

Initial value:

=  [
    "sphinx.ext.autodoc",
    "sphinx.ext.autosummary",
    "sphinx.ext.intersphinx",
    "sphinx_rtd_theme",
]

Definition at line 41 of file conf.py.

html_show_sourcelink

tuple conf.html_show_sourcelink

Initial value:

=  (
    True  # Remove 'view source code' from top of page (for html, not python)
)

Definition at line 55 of file conf.py.

html_static_path

list conf.html_static_path = ["_static"]

Definition at line 108 of file conf.py.

html_theme

string conf.html_theme = "sphinx_rtd_theme"

Definition at line 96 of file conf.py.

htmlhelp_basename

string conf.htmlhelp_basename = "moveit_coredoc"

Definition at line 124 of file conf.py.

intersphinx_mapping

dictionary conf.intersphinx_mapping = {"https://docs.python.org/3": None}

Definition at line 200 of file conf.py.

language

conf.language = None

Definition at line 80 of file conf.py.

latex_documents

list conf.latex_documents

Initial value:

=  [
    (master_doc, "moveit_core.tex", "moveit\\_core Documentation", "peter", "manual"),
]

Definition at line 147 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 129 of file conf.py.

man_pages

list conf.man_pages = [(master_doc, "moveit_core", "moveit_core Documentation", [author], 1)]

Definition at line 156 of file conf.py.

master_doc

string conf.master_doc = "index"

Definition at line 73 of file conf.py.

project

string conf.project = "moveit.core"

Definition at line 22 of file conf.py.

pygments_style

conf.pygments_style = None

Definition at line 88 of file conf.py.

release

string conf.release = ""

Definition at line 29 of file conf.py.

set_type_checking_flag

bool conf.set_type_checking_flag = True

Definition at line 59 of file conf.py.

source_suffix

string conf.source_suffix = ".rst"

Definition at line 70 of file conf.py.

templates_path

list conf.templates_path = ["_templates"]

Definition at line 64 of file conf.py.

texinfo_documents

list conf.texinfo_documents

Initial value:

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

Definition at line 164 of file conf.py.

version

string conf.version = ""

Definition at line 27 of file conf.py.