Skip to content

Commit

Permalink
Merge pull request #1097 from luxonis/update_docs_requirements
Browse files Browse the repository at this point in the history
Updated versions of sphinx requirements
  • Loading branch information
Erol444 authored Aug 10, 2023
2 parents 11f12f0 + dd0dabd commit c6f1263
Show file tree
Hide file tree
Showing 61 changed files with 88 additions and 83 deletions.
9 changes: 5 additions & 4 deletions depthai_sdk/docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
Sphinx==4.2.0
sphinx-rtd-theme==0.5.0
autodocsumm==0.2.10
sphinx-tabs==3.4.0
Sphinx==3.4.3
sphinx-rtd-theme==0.5.2
autodocsumm==0.2.2
sphinx-tabs==1.3.0
jinja2==3.0.3
Binary file modified depthai_sdk/docs/source/_static/images/favicon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed depthai_sdk/docs/source/_static/images/logo.png
Binary file not shown.
2 changes: 1 addition & 1 deletion depthai_sdk/docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
# -- Project information -----------------------------------------------------

project = 'DepthAI SDK Docs'
copyright = u"@build_year@, Luxonis"
html_show_copyright=False
author = 'Luxonis'

# The full version, including alpha/beta/rc tags
Expand Down
2 changes: 1 addition & 1 deletion depthai_sdk/docs/source/features/conditional-actions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ When the trigger is activated, it records a 15 seconds video (5 seconds before t
:language: python

Reference
-------------
---------

.. autoclass:: depthai_sdk.trigger_action.TriggerAction
:members:
Expand Down
6 changes: 4 additions & 2 deletions depthai_sdk/docs/source/fundamentals/components.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,16 @@ Components
Components are part of the :ref:`OakCamera` class and abstract `DepthAI API nodes <https://docs.luxonis.com/projects/api/en/latest/components/nodes/>`__;
their initialization, configuration, and linking. This improves ease of use when developing OAK aplications.

**Available components**
Available components
--------------------

- :ref:`CameraComponent`
- :ref:`NNComponent`
- :ref:`StereoComponent`
- :ref:`IMUComponent`

**Reference**
Reference
---------

.. autoclass:: depthai_sdk.components.Component
:members:
Expand Down
2 changes: 1 addition & 1 deletion depthai_sdk/docs/source/fundamentals/packets.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Packets are **synchronized collections** of one or more `DepthAI messages <https
#. Used callback output via :meth:`OakCamera.callback(..., callback=fn, enable_visualizer=True) <depthai_sdk.OakCamera.callback>`.

API Usage
#####
#########

#. :meth:`OakCamera.visualize() <depthai_sdk.OakCamera.visualize>`: In the example below SDK won't show the frame to the user, but instead it will send the packet to the callback function. SDK will draw detections (bounding boxes, labels) on the ``packet.frame``.
#. :meth:`OakCamera.callback() <depthai_sdk.OakCamera.callback>`: This will also send :class:`DetectionPacket <depthai_sdk.classes.packets.DetectionPacket>` to the callback function, the only difference is that the SDK won't draw on the frame, so you can draw detections on the frame yourself.
Expand Down
2 changes: 1 addition & 1 deletion depthai_sdk/docs/source/includes/footer-short.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@
<h2>Got questions?</h2>

Head over to <a href="https://discuss.luxonis.com/"><strong>Discussion Forum</strong></a> for technical support or any other questions you might have.
|

Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Source Code

.. tab:: Python

Also `available on GitHub <https://github.com/luxonis/depthai/depthai_sdk/examples/CameraComponent/cam_ffc.py>`__
Also `available on GitHub <https://github.com/luxonis/depthai/tree/main/depthai_sdk/examples/CameraComponent/cam_ffc.py>`__

.. literalinclude:: ../../../../examples/CameraComponent/cam_ffc.py
:language: python
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Source Code

.. tab:: Python

Also `available on GitHub <https://github.com/luxonis/depthai/depthai_sdk/examples/CameraComponent/camera_control.py>`__
Also `available on GitHub <https://github.com/luxonis/depthai/tree/main/depthai_sdk/examples/CameraComponent/camera_control.py>`__

.. literalinclude:: ../../../../examples/CameraComponent/camera_control.py
:language: python
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,9 @@ Source Code

.. tab:: Python

Also `available on GitHub <https://github.com/luxonis/depthai/depthai_sdk/examples/CameraComponent/camera_control_with_NN.py>`__
Also `available on GitHub <https://github.com/luxonis/depthai/tree/main/depthai_sdk/examples/CameraComponent/camera_control_with_nn.py>`__

.. literalinclude:: ../../../../examples/CameraComponent/camera_control_with_NN.py
.. literalinclude:: ../../../../examples/CameraComponent/camera_control_with_nn.py
:language: python
:linenos:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Source Code

.. tab:: Python

Also `available on GitHub <https://github.com/luxonis/depthai/depthai_sdk/examples/CameraComponent/camera_preview.py>`__
Also `available on GitHub <https://github.com/luxonis/depthai/tree/main/depthai_sdk/examples/CameraComponent/camera_preview.py>`__

.. literalinclude:: ../../../../examples/CameraComponent/camera_preview.py
:language: python
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Source Code

.. tab:: Python

Also `available on GitHub <https://github.com/luxonis/depthai/depthai_sdk/examples/CameraComponent/mono_400p.py>`__
Also `available on GitHub <https://github.com/luxonis/depthai/tree/main/depthai_sdk/examples/CameraComponent/mono_400p.py>`__

.. literalinclude:: ../../../../examples/CameraComponent/mono_400p.py
:language: python
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Source Code

.. tab:: Python

Also `available on GitHub <https://github.com/luxonis/depthai/depthai_sdk/examples/CameraComponent/preview_all_cameras.py>`__
Also `available on GitHub <https://github.com/luxonis/depthai/tree/main/depthai_sdk/examples/CameraComponent/preview_all_cameras.py>`__

.. literalinclude:: ../../../../examples/CameraComponent/preview_all_cameras.py
:language: python
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Source Code

.. tab:: Python

Also `available on GitHub <https://github.com/luxonis/depthai/depthai_sdk/examples/CameraComponent/rgb_mono_preview.py>`__
Also `available on GitHub <https://github.com/luxonis/depthai/tree/main/depthai_sdk/examples/CameraComponent/rgb_mono_preview.py>`__

.. literalinclude:: ../../../../examples/CameraComponent/rgb_mono_preview.py
:language: python
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Source Code

.. tab:: Python

Also `available on GitHub <https://github.com/luxonis/depthai/depthai_sdk/examples/CameraComponent/rotated.py>`__
Also `available on GitHub <https://github.com/luxonis/depthai/tree/main/depthai_sdk/examples/CameraComponent/rotated.py>`__

.. literalinclude:: ../../../../examples/CameraComponent/rotated.py
:language: python
Expand Down
2 changes: 1 addition & 1 deletion depthai_sdk/docs/source/samples/IMUComponent/sdk_imu.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Source Code

.. tab:: Python

Also `available on GitHub <https://github.com/luxonis/depthai/depthai_sdk/examples/IMUComponent/imu.py>`__.
Also `available on GitHub <https://github.com/luxonis/depthai/tree/main/depthai_sdk/examples/IMUComponent/imu.py>`__.

.. literalinclude:: ../../../../examples/IMUComponent/imu.py
:language: python
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Source Code

.. tab:: Python

Also `available on GitHub <https://github.com/luxonis/depthai/depthai_sdk/examples/IMUComponent/imu_rerun.py>`__.
Also `available on GitHub <https://github.com/luxonis/depthai/tree/main/depthai_sdk/examples/IMUComponent/imu_rerun.py>`__.

.. literalinclude:: ../../../../examples/IMUComponent/imu_rerun.py
:language: python
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Source Code

.. tab:: Python

Also `available on GitHub <https://github.com/luxonis/depthai/depthai_sdk/NNComponent/age-gender.py>`_.
Also `available on GitHub <https://github.com/luxonis/depthai/tree/main/depthai_sdk/examples/NNComponent/age-gender.py>`_.

.. literalinclude:: ../../../../examples/NNComponent/age-gender.py
:language: python
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Source Code

.. tab:: Python

Also `available on GitHub <https://github.com/luxonis/depthai/depthai_sdk/NNComponent/custom_decode.py>`_.
Also `available on GitHub <https://github.com/luxonis/depthai/tree/main/depthai_sdk/examples/NNComponent/custom_decode.py>`_.

.. literalinclude:: ../../../../examples/NNComponent/custom_decode.py
:language: python
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,11 @@ Source Code
###########

One thing worth noting is the resize mode option. Because inference is done on a color camera which has a 16:9 aspect ratio, and the model expects a 1:1 aspect ratio, we need
to resize the input frame to fit the model. This is done in three ways:
- letterbox - resize the frame to fit the model, and pad the rest with black pixels
- crop - crop the frame to fit the model
- stretch - stretch the frame to fit the model
to resize the input frame to fit the model. This is done in three ways:

- letterbox - resize the frame to fit the model, and pad the rest with black pixels
- crop - crop the frame to fit the model
- stretch - stretch the frame to fit the model

More information at `Maximizing FOV <https://docs.luxonis.com/projects/api/en/latest/tutorials/maximize_fov/>`__.

Expand All @@ -37,7 +38,7 @@ More information at `Maximizing FOV <https://docs.luxonis.com/projects/api/en/la

.. tab:: Python

Also `available on GitHub <https://github.com/luxonis/depthai/depthai_sdk/NNComponent/deeplabv3_person.py>`__
Also `available on GitHub <https://github.com/luxonis/depthai/tree/main/depthai_sdk/examples/NNComponent/deeplabv3_person.py>`__

.. literalinclude:: ../../../../examples/NNComponent/deeplabv3_person.py
:language: python
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Source Code

.. tab:: Python

Also `available on GitHub <https://github.com/luxonis/depthai/depthai_sdk/NNComponent/emotion-recognition.py>`_.
Also `available on GitHub <https://github.com/luxonis/depthai/tree/main/depthai_sdk/examples/NNComponent/emotion-recognition.py>`_.

.. literalinclude:: ../../../../examples/NNComponent/emotion-recognition.py
:language: python
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Source Code

.. tab:: Python

Also `available on GitHub <https://github.com/luxonis/depthai/depthai_sdk/NNComponent/face_detection_color.py>`_.
Also `available on GitHub <https://github.com/luxonis/depthai/tree/main/depthai_sdk/examples/NNComponent/face_detection_color.py>`_.

.. literalinclude:: ../../../../examples/NNComponent/face_detection_color.py
:language: python
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Source Code

.. tab:: Python

Also `available on GitHub <https://github.com/luxonis/depthai/depthai_sdk/NNComponent/face_detection_left.py>`_.
Also `available on GitHub <https://github.com/luxonis/depthai/tree/main/depthai_sdk/examples/NNComponent/face_detection_left.py>`_.

.. literalinclude:: ../../../../examples/NNComponent/face_detection_left.py
:language: python
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Source Code

.. tab:: Python

Also `available on GitHub <https://github.com/luxonis/depthai/depthai_sdk/NNComponent/human_pose.py>`_.
Also `available on GitHub <https://github.com/luxonis/depthai/tree/main/depthai_sdk/examples/NNComponent/human_pose.py>`_.

.. literalinclude:: ../../../../examples/NNComponent/human_pose.py
:language: python
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Source Code

.. tab:: Python

Also `available on GitHub <https://github.com/luxonis/depthai/depthai_sdk/NNComponent/mobilenet_encoded.py>`_.
Also `available on GitHub <https://github.com/luxonis/depthai/tree/main/depthai_sdk/examples/NNComponent/mobilenet_encoded.py>`_.

.. literalinclude:: ../../../../examples/NNComponent/mobilenet_encoded.py
:language: python
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ For additional models, check: `models supported by SDK <https://docs.luxonis.com


.. include:: /includes/blocking_behavior.rst



Setup
Expand All @@ -29,7 +28,7 @@ Source Code

.. tab:: Python

Also `available on GitHub <https://github.com/luxonis/depthai/depthai_sdk/NNComponent/nn_component.py>`__.
Also `available on GitHub <https://github.com/luxonis/depthai/tree/main/depthai_sdk/examples/NNComponent/nn_component.py>`__.

.. literalinclude:: ../../../../examples/NNComponent/nn_component.py
:language: python
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Source Code

.. tab:: Python

Also `available on GitHub <https://github.com/luxonis/depthai/depthai_sdk/NNComponent/object_tracking.py>`__.
Also `available on GitHub <https://github.com/luxonis/depthai/tree/main/depthai_sdk/examples/NNComponent/object_tracking.py>`__.

.. literalinclude:: ../../../../examples/NNComponent/object_tracking.py
:language: python
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Source Code

.. tab:: Python

Also `available on GitHub <https://github.com/luxonis/depthai/depthai_sdk/NNComponent/roboflow_integration.py>`__.
Also `available on GitHub <https://github.com/luxonis/depthai/tree/main/depthai_sdk/examples/NNComponent/roboflow_integration.py>`__.

.. literalinclude:: ../../../../examples/NNComponent/roboflow_integration.py
:language: python
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Source Code

.. tab:: Python

Also `available on GitHub <https://github.com/luxonis/depthai/depthai_sdk/NNComponent/spatial_detection.py>`__
Also `available on GitHub <https://github.com/luxonis/depthai/tree/main/depthai_sdk/examples/NNComponent/spatial_detection.py>`__


.. literalinclude:: ../../../../examples/NNComponent/spatial_detection.py
Expand Down
2 changes: 1 addition & 1 deletion depthai_sdk/docs/source/samples/NNComponent/sdk_yolo.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Source Code

.. tab:: Python

Also `available on GitHub <https://github.com/luxonis/depthai/depthai_sdk/NNComponent/yolo.py>`__.
Also `available on GitHub <https://github.com/luxonis/depthai/tree/main/depthai_sdk/examples/NNComponent/yolo.py>`__.


.. literalinclude:: ../../../../examples/NNComponent/yolo.py
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,9 @@ Source Code

.. tab:: Python

Also `available on GitHub <https://github.com/luxonis/depthai/depthai_sdk/PointcloudComonent/pointcloud.py>`_.
Also `available on GitHub <https://github.com/luxonis/depthai/tree/main/depthai_sdk/examples/PointcloudComponent/pointcloud.py>`_.



.. literalinclude:: ../../../../examples/PointcloudComonent/pointcloud.py
.. literalinclude:: ../../../../examples/PointcloudComponent/pointcloud.py
:language: python
:linenos:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Source Code

.. tab:: Python

Also `available on GitHub <https://github.com/luxonis/depthai/depthai_sdk/StereoComponent/stereo.py>`_.
Also `available on GitHub <https://github.com/luxonis/depthai/tree/main/depthai_sdk/examples/StereoComponent/stereo.py>`_.


.. literalinclude:: ../../../../examples/StereoComponent/stereo.py
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Source Code

.. tab:: Python

Also `available on GitHub <https://github.com/luxonis/depthai/depthai_sdk/StereoComponent/stereo_auto_ir.py>`_.
Also `available on GitHub <https://github.com/luxonis/depthai/tree/main/depthai_sdk/examples/StereoComponent/stereo_auto_ir.py>`_.

.. literalinclude:: ../../../../examples/StereoComponent/stereo_auto_ir.py
:language: python
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Source Code

.. tab:: Python

Also `available on GitHub <https://github.com/luxonis/depthai/depthai_sdk/StereoComponent/stereo_control.py>`_.
Also `available on GitHub <https://github.com/luxonis/depthai/tree/main/depthai_sdk/examples/StereoComponent/stereo_control.py>`_.

.. literalinclude:: ../../../../examples/StereoComponent/stereo_control.py
:language: python
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Source Code

.. tab:: Python

Also `available on GitHub <https://github.com/luxonis/depthai/depthai_sdk/StereoComponent/stereo_encoded.py>`_.
Also `available on GitHub <https://github.com/luxonis/depthai/tree/main/depthai_sdk/examples/StereoComponent/stereo_encoded.py>`_.

.. literalinclude:: ../../../../examples/StereoComponent/stereo_encoded.py
:language: python
Expand Down
2 changes: 0 additions & 2 deletions depthai_sdk/docs/source/samples/color_example.rst

This file was deleted.

2 changes: 1 addition & 1 deletion depthai_sdk/docs/source/samples/mixed/sdk_api_interop.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Source Code

.. tab:: Python

Also `available on GitHub <https://github.com/luxonis/depthai/depthai_sdk/examples/mixed/api_interop.py>`_.
Also `available on GitHub <https://github.com/luxonis/depthai/tree/main/depthai_sdk/examples/mixed/api_interop.py>`_.

.. literalinclude:: ../../../../examples/mixed/api_interop.py
:language: python
Expand Down
2 changes: 1 addition & 1 deletion depthai_sdk/docs/source/samples/mixed/sdk_car_tracking.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Source Code

.. tab:: Python

Also `available on GitHub <https://github.com/luxonis/depthai/depthai_sdk/examples/mixed/car_tracking.py>`_.
Also `available on GitHub <https://github.com/luxonis/depthai/tree/main/depthai_sdk/examples/mixed/car_tracking.py>`_.

.. literalinclude:: ../../../../examples/mixed/car_tracking.py
:language: python
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Source Code

.. tab:: Python

Also `available on GitHub <https://github.com/luxonis/depthai/depthai_sdk/examples/mixed/collision_avoidance.py>`_.
Also `available on GitHub <https://github.com/luxonis/depthai/tree/main/depthai_sdk/examples/mixed/collision_avoidance.py>`_.

.. literalinclude:: ../../../../examples/mixed/collision_avoidance.py
:language: python
Expand Down
Loading

0 comments on commit c6f1263

Please sign in to comment.