Remove pypi release tag and simplify install instructions (luxonis#156)

VanDavv · web-flow · commit 75b8add80c4f · 2021-03-17T15:29:10.000+01:00
* fix_pypi_release_tag

* use latest versions for builds

* skip numpy install (installed as opencv dependency)

* add common install file

* fix tag name in install ref

* update ref label
diff --git a/docs/conf.py.in b/docs/conf.py.in
@@ -23,7 +23,6 @@ copyright = u"@build_year@, Luxonis"
 author = "Luxonis"
 version = u"@DEPTHAI_PYTHON_VERSION@"
 release = version
-pypi_release = "2.0.0.1"
 
 
 # -- General configuration ---------------------------------------------------
diff --git a/docs/source/includes/install_from_pypi.rst b/docs/source/includes/install_from_pypi.rst
@@ -0,0 +1,11 @@
+Please run the following command to install the required dependencies
+
+.. code-block:: python
+   :substitutions:
+
+    python3 -m pip install -U pip
+    python3 -m pip install opencv-python
+    python3 -m pip install -U --force-reinstall depthai
+
+
+For additional information, please follow :ref:`installation guide <Installation>`
diff --git a/docs/source/samples/01_rgb_preview.rst b/docs/source/samples/01_rgb_preview.rst
@@ -17,15 +17,7 @@ Demo
 Setup
 #####
 
-Please run the following command to install the required dependencies
-
-.. code-block:: bash
-  :substitutions:
-
-  python3 -m pip install depthai==2.0.0.1 numpy==1.19.5 opencv-python==4.5.1.48
-
-
-For additional information, please follow :ref:`Python API installation guide <Installation - Python>`
+.. include::  /includes/install_from_pypi.rst
 
 Source code
 ###########
diff --git a/docs/source/samples/02_mono_preview.rst b/docs/source/samples/02_mono_preview.rst
@@ -16,15 +16,7 @@ Demo
 Setup
 #####
 
-Please run the following command to install the required dependencies
-
-.. code-block:: bash
-  :substitutions:
-
-  python3 -m pip install depthai==2.0.0.1 numpy==1.19.5 opencv-python==4.5.1.48
-
-
-For additional information, please follow :ref:`Python API installation guide <Installation - Python>`
+.. include::  /includes/install_from_pypi.rst
 
 Source code
 ###########
diff --git a/docs/source/samples/03_depth_preview.rst b/docs/source/samples/03_depth_preview.rst
@@ -17,15 +17,7 @@ Demo
 Setup
 #####
 
-Please run the following command to install the required dependencies
-
-.. code-block:: bash
-  :substitutions:
-
-  python3 -m pip install depthai==2.0.0.1 numpy==1.19.5 opencv-python==4.5.1.48
-
-
-For additional information, please follow :ref:`Python API installation guide <Installation - Python>`
+.. include::  /includes/install_from_pypi.rst
 
 Source code
 ###########
diff --git a/docs/source/samples/04_rgb_encoding.rst b/docs/source/samples/04_rgb_encoding.rst
@@ -25,15 +25,7 @@ Demo
 Setup
 #####
 
-Please run the following command to install the required dependencies
-
-.. code-block:: bash
-  :substitutions:
-
-  python3 -m pip install depthai==2.0.0.1 numpy==1.19.5 opencv-python==4.5.1.48
-
-
-For additional information, please follow :ref:`Python API installation guide <Installation - Python>`
+.. include::  /includes/install_from_pypi.rst
 
 Source code
 ###########
diff --git a/docs/source/samples/05_rgb_mono_encoding.rst b/docs/source/samples/05_rgb_mono_encoding.rst
@@ -23,15 +23,7 @@ Demo
 Setup
 #####
 
-Please run the following command to install the required dependencies
-
-.. code-block:: bash
-  :substitutions:
-
-  python3 -m pip install depthai==2.0.0.1 numpy==1.19.5 opencv-python==4.5.1.48
-
-
-For additional information, please follow :ref:`Python API installation guide <Installation - Python>`
+.. include::  /includes/install_from_pypi.rst
 
 Source code
 ###########
diff --git a/docs/source/samples/06_rgb_full_resolution_saver.rst b/docs/source/samples/06_rgb_full_resolution_saver.rst
@@ -22,15 +22,7 @@ Demo
 Setup
 #####
 
-Please run the following command to install the required dependencies
-
-.. code-block:: bash
-  :substitutions:
-
-  python3 -m pip install depthai==2.0.0.1 numpy==1.19.5 opencv-python==4.5.1.48
-
-
-For additional information, please follow :ref:`Python API installation guide <Installation - Python>`
+.. include::  /includes/install_from_pypi.rst
 
 Source code
 ###########
diff --git a/docs/source/samples/07_mono_full_resolution_saver.rst b/docs/source/samples/07_mono_full_resolution_saver.rst
@@ -16,15 +16,7 @@ Demo
 Setup
 #####
 
-Please run the following command to install the required dependencies
-
-.. code-block:: bash
-  :substitutions:
-
-  python3 -m pip install depthai==2.0.0.1 numpy==1.19.5 opencv-python==4.5.1.48
-
-
-For additional information, please follow :ref:`Python API installation guide <Installation - Python>`
+.. include::  /includes/install_from_pypi.rst
 
 Source code
 ###########
diff --git a/docs/source/samples/08_rgb_mobilenet.rst b/docs/source/samples/08_rgb_mobilenet.rst
@@ -16,15 +16,7 @@ Demo
 Setup
 #####
 
-Please run the following command to install the required dependencies
-
-.. code-block:: bash
-  :substitutions:
-
-  python3 -m pip install depthai==2.0.0.1 numpy==1.19.5 opencv-python==4.5.1.48
-
-
-For additional information, please follow :ref:`Python API installation guide <Installation - Python>`
+.. 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>`__
diff --git a/docs/source/samples/09_mono_mobilenet.rst b/docs/source/samples/09_mono_mobilenet.rst
@@ -16,15 +16,8 @@ Demo
 Setup
 #####
 
-Please run the following command to install the required dependencies
 
-.. code-block:: bash
-  :substitutions:
-
-  python3 -m pip install depthai==2.0.0.1 numpy==1.19.5 opencv-python==4.5.1.48
-
-
-For additional information, please follow :ref:`Python API installation guide <https://docs.luxonis.com/projects/api/en/latest/install/>`
+.. 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>`__
diff --git a/docs/source/samples/10_mono_depth_mobilenetssd.rst b/docs/source/samples/10_mono_depth_mobilenetssd.rst
@@ -17,15 +17,7 @@ Demo
 Setup
 #####
 
-Please run the following command to install the required dependencies
-
-.. code-block:: bash
-  :substitutions:
-
-  python3 -m pip install depthai==2.0.0.1 numpy==1.19.5 opencv-python==4.5.1.48
-
-
-For additional information, please follow :ref:`Python API installation guide <Installation - Python>`
+.. 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>`__
diff --git a/docs/source/samples/11_rgb_encoding_mono_mobilenet.rst b/docs/source/samples/11_rgb_encoding_mono_mobilenet.rst
@@ -24,15 +24,7 @@ Demo
 Setup
 #####
 
-Please run the following command to install the required dependencies
-
-.. code-block:: bash
-  :substitutions:
-
-  python3 -m pip install depthai==2.0.0.1 numpy==1.19.5 opencv-python==4.5.1.48
-
-
-For additional information, please follow :ref:`Python API installation guide <Installation - Python>`
+.. 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>`__
diff --git a/docs/source/samples/12_rgb_encoding_mono_mobilenet_depth.rst b/docs/source/samples/12_rgb_encoding_mono_mobilenet_depth.rst
@@ -26,15 +26,7 @@ Demo
 Setup
 #####
 
-Please run the following command to install the required dependencies
-
-.. code-block:: bash
-  :substitutions:
-
-  python3 -m pip install depthai==2.0.0.1 numpy==1.19.5 opencv-python==4.5.1.48
-
-
-For additional information, please follow :ref:`Python API installation guide <Installation - Python>`
+.. 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>`__
diff --git a/docs/source/samples/13_encoding_max_limit.rst b/docs/source/samples/13_encoding_max_limit.rst
@@ -24,15 +24,7 @@ Demo
 Setup
 #####
 
-Please run the following command to install the required dependencies
-
-.. code-block:: bash
-  :substitutions:
-
-  python3 -m pip install depthai==2.0.0.1 numpy==1.19.5 opencv-python==4.5.1.48
-
-
-For additional information, please follow :ref:`Python API installation guide <Installation - Python>`
+.. include::  /includes/install_from_pypi.rst
 
 Source code
 ###########
diff --git a/docs/source/samples/14_color_camera_control.rst b/docs/source/samples/14_color_camera_control.rst
@@ -22,15 +22,7 @@ Demo
 Setup
 #####
 
-Please run the following command to install the required dependencies
-
-.. code-block:: bash
-  :substitutions:
-
-  python3 -m pip install depthai==2.0.0.1 numpy==1.19.5 opencv-python==4.5.1.48
-
-
-For additional information, please follow :ref:`Python API installation guide <Installation - Python>`
+.. include::  /includes/install_from_pypi.rst
 
 Source code
 ###########
diff --git a/docs/source/samples/15_rgb_mobilenet_4k.rst b/docs/source/samples/15_rgb_mobilenet_4k.rst
@@ -18,15 +18,7 @@ Demo
 Setup
 #####
 
-Please run the following command to install the required dependencies
-
-.. code-block:: bash
-  :substitutions:
-
-  python3 -m pip install depthai==2.0.0.1 numpy==1.19.5 opencv-python==4.5.1.48
-
-
-For additional information, please follow :ref:`Python API installation guide <Installation - Python>`
+.. 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_5shave.blob>`__
diff --git a/docs/source/samples/16_device_queue_event.rst b/docs/source/samples/16_device_queue_event.rst
@@ -17,15 +17,7 @@ Demo
 Setup
 #####
 
-Please run the following command to install the required dependencies
-
-.. code-block:: bash
-  :substitutions:
-
-  python3 -m pip install depthai==2.0.0.1 numpy==1.19.5 opencv-python==4.5.1.48
-
-
-For additional information, please follow :ref:`Python API installation guide <Installation - Python>`
+.. include::  /includes/install_from_pypi.rst
 
 Source code
 ###########
diff --git a/docs/source/samples/17_video_mobilenet.rst b/docs/source/samples/17_video_mobilenet.rst
@@ -19,15 +19,7 @@ Demo
 Setup
 #####
 
-Please run the following command to install the required dependencies
-
-.. code-block:: bash
-  :substitutions:
-
-  python3 -m pip install depthai==2.0.0.1 numpy==1.19.5 opencv-python==4.5.1.48
-
-
-For additional information, please follow :ref:`Python API installation guide <Installation - Python>`
+.. include::  /includes/install_from_pypi.rst
 
 This example also requires MobilenetSDD blob (:code:`mobilenet.blob` file) and prerecorded video
 (:code:`construction_vest.mp4` file) to work - you can download them
diff --git a/docs/source/samples/18_rgb_encoding_mobilenet.rst b/docs/source/samples/18_rgb_encoding_mobilenet.rst
@@ -24,15 +24,7 @@ Demo
 Setup
 #####
 
-Please run the following command to install the required dependencies
-
-.. code-block:: bash
-  :substitutions:
-
-  python3 -m pip install depthai==2.0.0.1 numpy==1.19.5 opencv-python==4.5.1.48
-
-
-For additional information, please follow :ref:`Python API installation guide <Installation - Python>`
+.. 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>`__
diff --git a/docs/source/samples/21_mobilenet_decoding_on_device.rst b/docs/source/samples/21_mobilenet_decoding_on_device.rst
@@ -15,15 +15,7 @@ Demo
 Setup
 #####
 
-Please run the following command to install the required dependencies
-
-.. code-block:: bash
-  :substitutions:
-
-  python3 -m pip install depthai==2.0.0.1 numpy==1.19.5 opencv-python==4.5.1.48
-
-
-For additional information, please follow :ref:`Python API installation guide <Installation - Python>`
+.. 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>`__
diff --git a/docs/source/samples/22_tiny_tolo_v3_decoding_on_device.rst b/docs/source/samples/22_tiny_tolo_v3_decoding_on_device.rst
@@ -19,15 +19,7 @@ Demo
 Setup
 #####
 
-Please run the following command to install the required dependencies
-
-.. code-block:: bash
-  :substitutions:
-
-  python3 -m pip install depthai==2.0.0.1 numpy==1.19.5 opencv-python==4.5.1.48
-
-
-For additional information, please follow :ref:`Python API installation guide <Installation - Python>`
+.. 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/tiny-yolo-v3_openvino_2021.2_6shave.blob>`__
diff --git a/docs/source/samples/23_autoexposure_roi.rst b/docs/source/samples/23_autoexposure_roi.rst
@@ -16,15 +16,7 @@ Demo
 Setup
 #####
 
-Please run the following command to install the required dependencies
-
-.. code-block:: bash
-  :substitutions:
-
-  python3 -m pip install depthai==2.0.0.1 numpy==1.19.5 opencv-python==4.5.1.48
-
-
-For additional information, please follow :ref:`Python API installation guide <Installation - Python>`
+.. 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.blob>`__
diff --git a/docs/source/samples/24_opencv_support.rst b/docs/source/samples/24_opencv_support.rst
@@ -8,16 +8,7 @@ Both are displayed using functions `getFrame` and `getCvFrame`.
 Setup
 #####
 
-Please run the following command to install the required dependencies
-
-
-.. code-block:: bash
-  :substitutions:
-
-  python3 -m pip install depthai==2.0.0.1 numpy==1.19.5 opencv-python==4.5.1.48
-
-
-For additional information, please follow :ref:`Python API installation guide <Installation - Python>`
+.. 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.blob>`__
