Update rosdoc + sphinx config

This commit is contained in:
Robert Haschke 2022-01-04 21:27:07 +01:00
parent cfcc7ba112
commit 11686468ad
3 changed files with 7 additions and 25 deletions

View File

@ -33,24 +33,12 @@ extensions = [
] ]
autosummary_generate = True autosummary_generate = True
# Only add class doc in docstring as this is needed to clean up the autoclass_content = "both" # Add __init__ doc (ie. params) to class summaries
# constructor signature html_show_sourcelink = True # Remove 'view source code' from top of page (for html, not python)
autoclass_content = "class"
# Remove 'view source code' from top of page (for html, not python)
html_show_sourcelink = True
autodoc_inherit_docstrings = True # If no docstring, inherit from base class autodoc_inherit_docstrings = True # If no docstring, inherit from base class
# Enable 'expensive' imports for sphinx_autodoc_typehints set_type_checking_flag = True # Enable 'expensive' imports for sphinx_autodoc_typehints
set_type_checking_flag = True
add_module_names = False add_module_names = False
# Look for the function signature in the first line of the docstring.
autodoc_docstring_signature = True
# Interpret docstring formatting as to Numpy code style conventions.
# napoleon_google_docstring = True
# napoleon_numpy_docstring = True
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"] templates_path = ["_templates"]
@ -156,7 +144,7 @@ html_theme = "sphinx_rtd_theme"
# Add any paths that contain custom static files (such as style sheets) here, # 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, # relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css". # so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ["_static"] # html_static_path = ["_static"]
# Add any extra paths that contain custom files (such as robots.txt or # Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied # .htaccess) here, relative to this directory. These files are copied
@ -222,9 +210,7 @@ html_static_path = ["_static"]
htmlhelp_basename = "mtcdoc" htmlhelp_basename = "mtcdoc"
# Example configuration for intersphinx: refer to the Python standard library. # Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {"https://docs.python.org/3": None} intersphinx_mapping = {"python": ("https://docs.python.org/3", None)}
# Default options for generating documentation. # Default options for generating documentation.
autodoc_default_options = { autodoc_default_options = {"exclude-members": "ContainerBase, ParallelContainerBase, WrapperBase"}
"exclude-members": "ContainerBase, InitStageError, ParallelContainerBase, PlannerInterface, WrapperBase, PropagatingForward, PropagatingBackward, PropagatingEitherWay, MergeMode, SerialContainer, Solutions, PropertyInitializerSource"
}

View File

@ -46,10 +46,6 @@ void export_stages(pybind11::module& m);
} // namespace moveit } // namespace moveit
PYBIND11_MODULE(pymoveit_mtc, m) { PYBIND11_MODULE(pymoveit_mtc, m) {
// disable function signatures in generated documentation
pybind11::options options;
options.disable_function_signatures();
auto msub = m.def_submodule("core", R"( auto msub = m.def_submodule("core", R"(
moveit.task_constructor.core moveit.task_constructor.core
============================ ============================

View File

@ -6,5 +6,5 @@
name: C++ API name: C++ API
output_dir: cpp output_dir: cpp
file_patterns: "*.c *.cpp *.h *.cc *.hh *.dox" file_patterns: "*.c *.cpp *.h *.cc *.hh *.dox"
exclude_patterns: "*/core/python/pybind11/* */test/*" exclude_patterns: "*/core/python/pybind11/* */core/python/bindings/* */test/* "
exclude_symbols: "*Private class_ declval*" exclude_symbols: "*Private class_ declval*"