ros / diagnostics

Packages related to gathering, viewing, and analyzing diagnostics data from robots.
https://index.ros.org/p/diagnostics/
Other
102 stars 178 forks source link

diagnostic_updater: Added documentation of the Python interface. #399

Open peci1 opened 2 months ago

peci1 commented 2 months ago

I've added a Sphinx config to generate Python docs for the diagnostic_updater package.

To retain references to the C++ API, I haven't generated the standard disambiguation page with C++/Python/Msg links, but I've kept C++ API docs in the original path, generated Python into a subfolder, and added a link to the Python API docs to the C++ docs.

The behavior of the code should not change, although I've added the __all__ variable to __init__.py to convince Sphinx to generate the package-level docs.