conf.py

Go to the documentation of this file.

# Configuration file for the Sphinx documentation builder.
#
# This file only contains a selection of the most common options. For a full
# list see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html
 
# -- Path setup --------------------------------------------------------------
 
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
# import os
# import sys
# sys.path.insert(0, os.path.abspath('../../../../../../build/moveit_py'))
 
 
# -- Project information -----------------------------------------------------
 
project = "moveit_py"
copyright = "2022, Peter David Fagan"
author = "Peter David Fagan"
 
 
# -- General configuration ---------------------------------------------------
 
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
    "sphinx.ext.napoleon",
    "sphinx.ext.autodoc",
    "sphinx.ext.autosummary",
    "sphinx_rtd_theme",
    "sphinx.ext.intersphinx",
]
 
intersphinx_mapping = {
    "numpy": ("https://numpy.org/doc/stable/", None),
    "geometry_msgs": ("http://docs.ros.org/en/latest/api/geometry_msgs/html/", None),
}
autodoc_typehints = "signature"
 
autodoc_default_options = {
    "members": True,
    "undoc-members": True,
    "member-order": "bysource",
}
 
autosummary_generate = True
 
# Napoleon settings
napoleon_google_docstring = True
napoleon_numpy_docstring = False
napoleon_include_init_with_doc = False
napoleon_include_private_with_doc = False
napoleon_include_special_with_doc = False
napoleon_use_admonition_for_examples = False
napoleon_use_admonition_for_notes = False
napoleon_use_admonition_for_references = False
napoleon_use_ivar = False
napoleon_use_param = False
napoleon_use_rtype = False
 
# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]
 
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = []
 
 
# -- Options for HTML output -------------------------------------------------
 
# The theme to use for HTML and HTML Help pages.  See the documentation for
# a list of builtin themes.
#
html_theme = "sphinx_rtd_theme"
 
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ["_static"]
 
master_doc = "index"