Add comprehensive documentation to Python via sphinx #3993
Merged
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
added 12 commits
May 16, 2019 13:54
… python code edits too
|
Note: Generating the documentation generates a lot of warnings and creates the folder wrappers/python/docs/_generated in the main tree (NOT the build tree). |
…s starting with _
bfulkers-i
reviewed
May 16, 2019
| @@ -407,7 +407,7 @@ namespace rs2 | |||
| void keep() { rs2_keep_frame(frame_ref); } | |||
|
|
|||
| /** | |||
| * Parenthesis operator check internal frame handle is valid. | |||
| * Parenthesis operator check if internal frame handle is valid. | |||
There was a problem hiding this comment.
The parenthesis operator checks if the
lramati
pushed a commit
to lramati/librealsense
that referenced
this pull request
May 19, 2019
ev-mp
approved these changes
May 19, 2019
There was a problem hiding this comment.
@lramati , LGTM.
This PR will definitely facilitate Python development without the need for constant cross-referencing.
@bfulkers-i , thank you for the rigorous review 👍
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.
Inline help is now much more comprehensive. Additionally, useful HTML docs can be generated with sphinx