Merge pull request #580 from luxonis/docker_docs_fix

Erol444 · web-flow · commit 3d86fe9c22ce · 2022-05-10T01:10:25.000+02:00
Updated docker run command
diff --git a/docs/source/includes/install_req.rst b/docs/source/includes/install_req.rst
@@ -0,0 +1,4 @@
+This example script **requires external file(s) to run**. If you are using:
+
+- depthai-python, run :code:`python3 examples/install_requirements.py` to download required file(s)
+- dephtai-core, required file(s) will get downloaded automatically when building the example
diff --git a/docs/source/install.rst b/docs/source/install.rst
@@ -277,7 +277,7 @@ Run the :code:`rgb_preview.py` example inside a Docker container on a Linux host
        -e DISPLAY=$DISPLAY \
        -v /tmp/.X11-unix:/tmp/.X11-unix \
        luxonis/depthai-library:latest \
-       python3 /depthai-python/examples/rgb_preview.py
+       python3 /depthai-python/examples/ColorCamera/rgb_preview.py
 
 To allow the container to update X11 you may need to run :code:`xhost local:root` on the host.
 
diff --git a/docs/source/samples/ColorCamera/autoexposure_roi.rst b/docs/source/samples/ColorCamera/autoexposure_roi.rst
@@ -27,8 +27,7 @@ Setup
 
 .. include::  /includes/install_from_pypi.rst
 
-This example also requires MobilenetSDD blob (:code:`mobilenet-ssd_openvino_2021.2_5shave.blob` file) to work - you can download it from
-`here <https://artifacts.luxonis.com/artifactory/luxonis-depthai-data-local/network/mobilenet-ssd_openvino_2021.2_5shave.blob>`__
+.. include:: /includes/install_req.rst
 
 Source code
 ###########
diff --git a/docs/source/samples/MobileNet/mono_mobilenet.rst b/docs/source/samples/MobileNet/mono_mobilenet.rst
@@ -25,8 +25,7 @@ Setup
 
 .. include::  /includes/install_from_pypi.rst
 
-This example also requires MobilenetSDD blob (:code:`mobilenet-ssd_openvino_2021.2_6shave.blob` file) to work - you can download it from
-`here <https://artifacts.luxonis.com/artifactory/luxonis-depthai-data-local/network/mobilenet-ssd_openvino_2021.2_6shave.blob>`__
+.. include:: /includes/install_req.rst
 
 Source code
 ###########
diff --git a/docs/source/samples/MobileNet/rgb_mobilenet.rst b/docs/source/samples/MobileNet/rgb_mobilenet.rst
@@ -25,8 +25,7 @@ Setup
 
 .. include::  /includes/install_from_pypi.rst
 
-This example also requires MobilenetSDD blob (:code:`mobilenet-ssd_openvino_2021.2_6shave.blob` file) to work - you can download it from
-`here <https://artifacts.luxonis.com/artifactory/luxonis-depthai-data-local/network/mobilenet-ssd_openvino_2021.2_6shave.blob>`__
+.. include:: /includes/install_req.rst
 
 Source code
 ###########
diff --git a/docs/source/samples/MobileNet/rgb_mobilenet_4k.rst b/docs/source/samples/MobileNet/rgb_mobilenet_4k.rst
@@ -29,8 +29,7 @@ Setup
 
 .. include::  /includes/install_from_pypi.rst
 
-This example also requires MobilenetSDD blob (:code:`mobilenet-ssd_openvino_2021.2_5shave.blob` file) to work - you can download it from
-`here <https://artifacts.luxonis.com/artifactory/luxonis-depthai-data-local/network/mobilenet-ssd_openvino_2021.2_5shave.blob>`__
+.. include:: /includes/install_req.rst
 
 Source code
 ###########
diff --git a/docs/source/samples/MobileNet/video_mobilenet.rst b/docs/source/samples/MobileNet/video_mobilenet.rst
@@ -27,10 +27,7 @@ Setup
 
 .. include::  /includes/install_from_pypi.rst
 
-This example also requires MobilenetSDD blob (:code:`mobilenet-ssd_openvino_2021.2_8shave.blob` file) and prerecorded video
-(:code:`construction_vest.mp4` file) to work - you can download them
-here: `mobilenet-ssd_openvino_2021.2_8shave.blob <https://artifacts.luxonis.com/artifactory/luxonis-depthai-data-local/network/mobilenet-ssd_openvino_2021.2_8shave.blob>`__
-and `construction_vest.mp4 <https://artifacts.luxonis.com/artifactory/luxonis-depthai-data-local/network/construction_vest.mp4>`__
+.. include:: /includes/install_req.rst
 
 Source code
 ###########
diff --git a/docs/source/samples/ObjectTracker/object_tracker.rst b/docs/source/samples/ObjectTracker/object_tracker.rst
@@ -24,8 +24,7 @@ Setup
 
 .. include::  /includes/install_from_pypi.rst
 
-This example also requires MobilenetSDD blob (:code:`mobilenet.blob` file) to work - you can download it from
-`here <https://artifacts.luxonis.com/artifactory/luxonis-depthai-data-local/network/mobilenet-ssd_openvino_2021.2_6shave.blob>`__
+.. include:: /includes/install_req.rst
 
 Source code
 ###########
diff --git a/docs/source/samples/ObjectTracker/object_tracker_video.rst b/docs/source/samples/ObjectTracker/object_tracker_video.rst
@@ -17,8 +17,7 @@ Setup
 
 .. include::  /includes/install_from_pypi.rst
 
-This example also requires MobilenetSDD based person-detection blob (:code:`person-detection-0201_openvino_2021.3_7shave.blob` file) to work - you can download it from
-`here <https://artifacts.luxonis.com/artifactory/luxonis-depthai-data-local/network/person-detection-0201_openvino_2021.3_7shave.blob>`__
+.. include:: /includes/install_req.rst
 
 Source code
 ###########
diff --git a/docs/source/samples/ObjectTracker/spatial_object_tracker.rst b/docs/source/samples/ObjectTracker/spatial_object_tracker.rst
@@ -19,8 +19,7 @@ Setup
 
 .. include::  /includes/install_from_pypi.rst
 
-This example also requires MobilenetSDD blob (:code:`mobilenet.blob` file) to work - you can download it from
-`here <https://artifacts.luxonis.com/artifactory/luxonis-depthai-data-local/network/mobilenet-ssd_openvino_2021.2_6shave.blob>`__
+.. include:: /includes/install_req.rst
 
 Source code
 ###########
diff --git a/docs/source/samples/SpatialDetection/spatial_mobilenet.rst b/docs/source/samples/SpatialDetection/spatial_mobilenet.rst
@@ -29,8 +29,7 @@ Setup
 
 .. include::  /includes/install_from_pypi.rst
 
-This example also requires MobilenetSDD blob (:code:`mobilenet-ssd_openvino_2021.2_6shave.blob` file) to work - you can download it from
-`here <https://artifacts.luxonis.com/artifactory/luxonis-depthai-data-local/network/mobilenet-ssd_openvino_2021.2_6shave.blob>`__
+.. include:: /includes/install_req.rst
 
 Source code
 ###########
diff --git a/docs/source/samples/SpatialDetection/spatial_mobilenet_mono.rst b/docs/source/samples/SpatialDetection/spatial_mobilenet_mono.rst
@@ -29,8 +29,7 @@ Setup
 
 .. include::  /includes/install_from_pypi.rst
 
-This example also requires MobilenetSDD blob (:code:`mobilenet-ssd_openvino_2021.2_6shave.blob` file) to work - you can download it from
-`here <https://artifacts.luxonis.com/artifactory/luxonis-depthai-data-local/network/mobilenet-ssd_openvino_2021.2_6shave.blob>`__
+.. include:: /includes/install_req.rst
 
 Source code
 ###########
diff --git a/docs/source/samples/SpatialDetection/spatial_tiny_yolo.rst b/docs/source/samples/SpatialDetection/spatial_tiny_yolo.rst
@@ -35,11 +35,7 @@ Setup
 
 .. include::  /includes/install_from_pypi.rst
 
-This example also requires YOLOv4-tiny blob (:code:`tiny-yolo-v4_openvino_2021.2_6shave.blob` file) to work - you can download it from
-`here <https://artifacts.luxonis.com/artifactory/luxonis-depthai-data-local/network/tiny-yolo-v4_openvino_2021.2_6shave.blob>`__
-
-YOLOv3-tiny blob (:code:`tiny-yolo-v3_openvino_2021.2_6shave.blob` file) can be used too - you can download it from
-`here <https://artifacts.luxonis.com/artifactory/luxonis-depthai-data-local/network/tiny-yolo-v3_openvino_2021.2_6shave.blob>`__
+.. include:: /includes/install_req.rst
 
 Source code
 ###########
diff --git a/docs/source/samples/Yolo/tiny_yolo.rst b/docs/source/samples/Yolo/tiny_yolo.rst
@@ -29,8 +29,7 @@ Setup
 
 .. include::  /includes/install_from_pypi.rst
 
-This example also requires YOLOv4-tiny blob (:code:`tiny-yolo-v4_openvino_2021.2_6shave.blob` file) to work - you can download it from
-`here <https://artifacts.luxonis.com/artifactory/luxonis-depthai-data-local/network/tiny-yolo-v4_openvino_2021.2_6shave.blob>`__
+.. include:: /includes/install_req.rst
 
 Source code
 ###########
diff --git a/docs/source/samples/mixed/mono_depth_mobilenetssd.rst b/docs/source/samples/mixed/mono_depth_mobilenetssd.rst
@@ -27,8 +27,7 @@ Setup
 
 .. include::  /includes/install_from_pypi.rst
 
-This example also requires MobilenetSDD blob (:code:`mobilenet-ssd_openvino_2021.2_6shave.blob` file) to work - you can download it from
-`here <https://artifacts.luxonis.com/artifactory/luxonis-depthai-data-local/network/mobilenet-ssd_openvino_2021.2_6shave.blob>`__
+.. include:: /includes/install_req.rst
 
 Source code
 ###########
diff --git a/docs/source/samples/mixed/rgb_encoding_mobilenet.rst b/docs/source/samples/mixed/rgb_encoding_mobilenet.rst
@@ -36,8 +36,7 @@ Setup
 
 .. include::  /includes/install_from_pypi.rst
 
-This example also requires MobilenetSDD blob (:code:`mobilenet-ssd_openvino_2021.2_6shave.blob` file) to work - you can download it from
-`here <https://artifacts.luxonis.com/artifactory/luxonis-depthai-data-local/network/mobilenet-ssd_openvino_2021.2_6shave.blob>`__
+.. include:: /includes/install_req.rst
 
 Source code
 ###########
diff --git a/docs/source/samples/mixed/rgb_encoding_mono_mobilenet.rst b/docs/source/samples/mixed/rgb_encoding_mono_mobilenet.rst
@@ -37,8 +37,7 @@ Setup
 
 .. include::  /includes/install_from_pypi.rst
 
-This example also requires MobilenetSDD blob (:code:`mobilenet-ssd_openvino_2021.2_6shave.blob` file) to work - you can download it from
-`here <https://artifacts.luxonis.com/artifactory/luxonis-depthai-data-local/network/mobilenet-ssd_openvino_2021.2_6shave.blob>`__
+.. include:: /includes/install_req.rst
 
 Source code
 ###########
diff --git a/docs/source/samples/mixed/rgb_encoding_mono_mobilenet_depth.rst b/docs/source/samples/mixed/rgb_encoding_mono_mobilenet_depth.rst
@@ -38,8 +38,7 @@ Setup
 
 .. include::  /includes/install_from_pypi.rst
 
-This example also requires MobilenetSDD blob (:code:`mobilenet-ssd_openvino_2021.2_6shave.blob` file) to work - you can download it from
-`here <https://artifacts.luxonis.com/artifactory/luxonis-depthai-data-local/network/mobilenet-ssd_openvino_2021.2_6shave.blob>`__
+.. include:: /includes/install_req.rst
 
 Source code
 ###########
