diagnostic_updater: Added documentation of the Python interface. #399
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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__.pyto convince Sphinx to generate the package-level docs.