conf Namespace Reference

Variables
string	project = "moveit_py"
string	copyright = "2022, Peter David Fagan"
string	author = "Peter David Fagan"
list	extensions
dictionary	intersphinx_mapping
string	autodoc_typehints = "signature"
dictionary	autodoc_default_options
bool	autosummary_generate = True
bool	napoleon_google_docstring = True
bool	napoleon_numpy_docstring = False
bool	napoleon_include_init_with_doc = False
bool	napoleon_include_private_with_doc = False
bool	napoleon_include_special_with_doc = False
bool	napoleon_use_admonition_for_examples = False
bool	napoleon_use_admonition_for_notes = False
bool	napoleon_use_admonition_for_references = False
bool	napoleon_use_ivar = False
bool	napoleon_use_param = False
bool	napoleon_use_rtype = False
list	templates_path = ["_templates"]
list	exclude_patterns = []
string	html_theme = "sphinx_rtd_theme"
list	html_static_path = ["_static"]
string	master_doc = "index"

Variable Documentation

author

string conf.author = "Peter David Fagan"

Definition at line 22 of file conf.py.

autodoc_default_options

dictionary conf.autodoc_default_options

Initial value:

=  {
    "members": True,
    "undoc-members": True,
    "member-order": "bysource",
}

Definition at line 44 of file conf.py.

autodoc_typehints

string conf.autodoc_typehints = "signature"

Definition at line 42 of file conf.py.

autosummary_generate

bool conf.autosummary_generate = True

Definition at line 50 of file conf.py.

copyright

string conf.copyright = "2022, Peter David Fagan"

Definition at line 21 of file conf.py.

exclude_patterns

list conf.exclude_patterns = []

Definition at line 71 of file conf.py.

extensions

list conf.extensions

Initial value:

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

Definition at line 30 of file conf.py.

html_static_path

list conf.html_static_path = ["_static"]

Definition at line 84 of file conf.py.

html_theme

string conf.html_theme = "sphinx_rtd_theme"

Definition at line 79 of file conf.py.

intersphinx_mapping

dictionary conf.intersphinx_mapping

Initial value:

=  {
    "numpy": ("https://numpy.org/doc/stable/", None),
    "geometry_msgs": ("http://docs.ros.org/en/latest/api/geometry_msgs/html/", None),
}

Definition at line 38 of file conf.py.

master_doc

string conf.master_doc = "index"

Definition at line 86 of file conf.py.

napoleon_google_docstring

bool conf.napoleon_google_docstring = True

Definition at line 53 of file conf.py.

napoleon_include_init_with_doc

bool conf.napoleon_include_init_with_doc = False

Definition at line 55 of file conf.py.

napoleon_include_private_with_doc

bool conf.napoleon_include_private_with_doc = False

Definition at line 56 of file conf.py.

napoleon_include_special_with_doc

bool conf.napoleon_include_special_with_doc = False

Definition at line 57 of file conf.py.

napoleon_numpy_docstring

bool conf.napoleon_numpy_docstring = False

Definition at line 54 of file conf.py.

napoleon_use_admonition_for_examples

bool conf.napoleon_use_admonition_for_examples = False

Definition at line 58 of file conf.py.

napoleon_use_admonition_for_notes

bool conf.napoleon_use_admonition_for_notes = False

Definition at line 59 of file conf.py.

napoleon_use_admonition_for_references

bool conf.napoleon_use_admonition_for_references = False

Definition at line 60 of file conf.py.

napoleon_use_ivar

bool conf.napoleon_use_ivar = False

Definition at line 61 of file conf.py.

napoleon_use_param

bool conf.napoleon_use_param = False

Definition at line 62 of file conf.py.

napoleon_use_rtype

bool conf.napoleon_use_rtype = False

Definition at line 63 of file conf.py.

project

string conf.project = "moveit_py"

Definition at line 20 of file conf.py.

templates_path

list conf.templates_path = ["_templates"]

Definition at line 66 of file conf.py.