Adding code examples in docs #917
Merged
Conversation
This file contains hidden or 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
themarpe
approved these changes
Nov 7, 2023
Erol444
reviewed
Nov 14, 2023
Contributor
Erol444
left a comment
Erol444
left a comment
There was a problem hiding this comment.
Also, do we have UVC node docs page already?
examples/UVC/uvc_disparity.py
Outdated
Comment on lines
6
to
10
| parser = argparse.ArgumentParser() | ||
| parser.add_argument('-fb', '--flash-bootloader', default=False, action="store_true") | ||
| parser.add_argument('-f', '--flash-app', default=False, action="store_true") | ||
| parser.add_argument('-l', '--load-and-exit', default=False, action="store_true") | ||
| args = parser.parse_args() |
Contributor
There was a problem hiding this comment.
Maybe remove this flashing capability for disparity/mono - it only makes sense for uvc_rgb, more as a showcase
Contributor
Author
There was a problem hiding this comment.
Uvc node is not yet added since not all tests were run yet. The .rsts should have references to it though.
Erol444
suggested changes
Nov 15, 2023
docs/source/samples/UVC/uvc_rgb.rst
Outdated
| ================== | ||
|
|
||
| This example demonstrates how to use the RGB camera on your OAK device as a UVC webcam. The UVC feature allows you to use your OAK device as a regular webcam in applications like OpenCV's :code:`cv2.VideoCapture()`, native camera apps, and more. | ||
| This example demonstrates how to use the RGB camera on your OAK device as a UVC webcam. The :ref:`UVC` feature allows you to use your OAK device as a regular webcam in applications like OpenCV's :code:`cv2.VideoCapture()`, native camera apps, and more. |
Contributor
There was a problem hiding this comment.
Docs failing to build because:
/home/docs/checkouts/readthedocs.org/user_builds/luxonis-depthai-python/checkouts/917/docs/source/samples/UVC/uvc_disparity.rst:8: WARNING: undefined label: uvc
/home/docs/checkouts/readthedocs.org/user_builds/luxonis-depthai-python/checkouts/917/docs/source/samples/UVC/uvc_mono.rst:8: WARNING: undefined label: uvc
/home/docs/checkouts/readthedocs.org/user_builds/luxonis-depthai-python/checkouts/917/docs/source/samples/UVC/uvc_rgb.rst:4: WARNING: undefined label: uvc
/home/docs/checkouts/readthedocs.org/user_builds/luxonis-depthai-python/checkouts/917/docs/source/tutorials/code_samples.rst:76: WARNING: undefined label: feature motion estimation
Co-authored-by: Erol444 <erol123444@gmail.com>
Erol444
reviewed
Nov 20, 2023
Contributor
Erol444
left a comment
Erol444
left a comment
There was a problem hiding this comment.
Docs building fails:
/home/docs/checkouts/readthedocs.org/user_builds/luxonis-depthai-python/checkouts/917/docs/source/components/device.rst:69: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/home/docs/checkouts/readthedocs.org/user_builds/luxonis-depthai-python/checkouts/917/docs/source/components/device.rst:231: WARNING: Title level inconsistent:
Blocking behaviour
******************
/home/docs/checkouts/readthedocs.org/user_builds/luxonis-depthai-python/checkouts/917/docs/source/components/device.rst:244: WARNING: Title level inconsistent:
Non-Blocking behaviour
**********************
/home/docs/checkouts/readthedocs.org/user_builds/luxonis-depthai-python/checkouts/917/docs/source/components/device.rst:253: WARNING: Title level inconsistent:
Some additional information
***************************
/home/docs/checkouts/readthedocs.org/user_builds/luxonis-depthai-python/checkouts/917/docs/source/tutorials/debugging.rst:4: WARNING: undefined label: blocking behaviour
I think you'd just need to update the title consistency @jakaskerl
Erol444
approved these changes
Nov 20, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Added:
Changed: