Merge branch 'main' into docker-compose-hotfix

Author: Erol444

.github/workflows/main.yml

@@ -48,9 +48,9 @@ jobs:
           brew install libusb
           python -m pip install git+git://github.com/luxonis/pybind11_mkdoc.git@master
       - name: Configure project
-        run: cmake -S . -B build -DDEPTHAI_PYTHON_BUILD_DOCSTRINGS=ON -DDEPTHAI_PYTHON_FORCE_DOCSTRINGS=ON -DDEPTHAI_PYTHON_DOCSTRINGS_OUTPUT="$PWD/docstrings/depthai_python_docstring.hpp"
+        run: cmake -S . -B build -DDEPTHAI_PYTHON_FORCE_DOCSTRINGS=ON -DDEPTHAI_PYTHON_DOCSTRINGS_OUTPUT="$PWD/docstrings/depthai_python_docstring.hpp"
       - name: Build target 'pybind11_mkdoc'
-        run: cmake --build build --parallel --target pybind11_mkdoc
+        run: cmake --build build --target pybind11_mkdoc --parallel
       - name: Upload docstring artifacts
         uses: actions/upload-artifact@v2
         with:
@@ -247,7 +247,7 @@ jobs:
       - name: Build and install depthai-core
         run: |
           cmake -S depthai-core/ -B build_core -D CMAKE_BUILD_TYPE=Release -D CMAKE_TOOLCHAIN_FILE=$PWD/cmake/toolchain/pic.cmake
-          cmake --build build_core --parallel --target install
+          cmake --build build_core --target install --parallel
           echo "DEPTHAI_INSTALLATION_DIR=$PWD/build_core/install/" >> $GITHUB_ENV
 
       - name: Append build hash if not a tagged commit
@@ -309,7 +309,7 @@ jobs:
       - name: Build and install depthai-core
         run: |
           cmake -S depthai-core/ -B build_core -D CMAKE_BUILD_TYPE=Release -D CMAKE_TOOLCHAIN_FILE=$PWD/cmake/toolchain/pic.cmake
-          cmake --build build_core --parallel --target install
+          cmake --build build_core --target install --parallel
           echo "DEPTHAI_INSTALLATION_DIR=$PWD/build_core/install/" >> $GITHUB_ENV
 
       - name: Append build hash if not a tagged commit

.gitignore

@@ -28,3 +28,6 @@ _builds/
 
 #ci
 wheelhouse/
+
+# Example blobs/files
+examples/models/

CMakeLists.txt

@@ -38,19 +38,14 @@ list(APPEND CMAKE_MODULE_PATH "${PROJECT_SOURCE_DIR}/depthai-core/cmake")
 # Constants
 set(DOCSTRINGS_INCLUDE_PLACEHOLDER_DIR ${CMAKE_CURRENT_BINARY_DIR}/generated/include)
 set(DOCSTRINGS_INCLUDE_PLACEHOLDER_PATH ${DOCSTRINGS_INCLUDE_PLACEHOLDER_DIR}/docstring.hpp)
-set(DOCSTRINGS_OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/generated/include/depthai_python_docstring.hpp)
+set(DEFAULT_DOCSTRINGS_OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/generated/depthai_python_docstring.hpp)
 
 # First specify options
 option(DEPTHAI_PYTHON_USE_FIND_PACKAGE "Use find_package for depthai-core" OFF)
 option(DEPTHAI_PYTHON_ENABLE_TESTS "Enable tests" OFF)
 option(DEPTHAI_PYTHON_ENABLE_EXAMPLES "Enable examples" OFF)
 option(DEPTHAI_PYTHON_BUILD_DOCS "Build documentation - see docs/requirements.txt for needed dependencies" OFF)
 option(DEPTHAI_PYTHON_BUILD_DOCSTRINGS "Generate docstrings from header files if module 'pybind11_mkdoc' available" ON)
-set(DEPTHAI_PYTHON_DOCSTRINGS_INPUT ${DOCSTRINGS_OUTPUT} CACHE FILEPATH "Path to docstring for bindings") 
-set(DEPTHAI_PYTHON_DOCSTRINGS_OUTPUT ${DOCSTRINGS_OUTPUT} CACHE FILEPATH "Path where docstring file will be generated") 
-if(DEPTHAI_PYTHON_BUILD_DOCSTRINGS)
-    option(DEPTHAI_PYTHON_FORCE_DOCSTRINGS "Force that docstrings are generated, module 'pybind11_mkdoc' required" OFF)
-endif()
 
 # Add external dependencies
 add_subdirectory(external)
@@ -89,22 +84,51 @@ pybind11_add_module(${TARGET_NAME}
     src/log/LogBindings.cpp
 )
 
+
+# Docstring options
+if(DEPTHAI_PYTHON_DOCSTRINGS_INPUT AND DEPTHAI_PYTHON_DOCSTRINGS_OUTPUT)
+    message(FATAL_ERROR "DEPTHAI_PYTHON_DOCSTRINGS_INPUT and DEPTHAI_PYTHON_DOCSTRINGS_OUTPUT are mutually exclusive")
+endif()
+
+if(DEPTHAI_PYTHON_DOCSTRINGS_OUTPUT)
+    # If output is specified set both input and output to same the path
+    set(docstring_input_path ${DEPTHAI_PYTHON_DOCSTRINGS_OUTPUT}) 
+    set(docstring_output_path ${DEPTHAI_PYTHON_DOCSTRINGS_OUTPUT}) 
+else()
+    # If input docstrings explicitly specified, use those and disable building
+    if(DEPTHAI_PYTHON_DOCSTRINGS_INPUT)
+        set(docstring_input_path ${DEPTHAI_PYTHON_DOCSTRINGS_INPUT})
+        message(STATUS "Disabled building of docstrings - using docstrings specified by DEPTHAI_PYTHON_DOCSTRINGS_INPUT (${DEPTHAI_PYTHON_DOCSTRINGS_INPUT})")
+        set(DEPTHAI_PYTHON_BUILD_DOCSTRINGS OFF CACHE BOOL "Generate docstrings from header files if module 'pybind11_mkdoc' available" FORCE)
+    else()
+        # Otherwise set default location as input
+        set(docstring_input_path ${DEFAULT_DOCSTRINGS_OUTPUT}) 
+    endif()
+
+    # Set default output location
+    set(docstring_output_path ${DEFAULT_DOCSTRINGS_OUTPUT}) 
+endif()
+
+if(DEPTHAI_PYTHON_BUILD_DOCSTRINGS)
+    option(DEPTHAI_PYTHON_FORCE_DOCSTRINGS "Force that docstrings are generated, module 'pybind11_mkdoc' required" OFF)
+endif()
+
 # Configure include placeholder with INPUT path
 configure_file(cmake/docstring.hpp.in ${DOCSTRINGS_INCLUDE_PLACEHOLDER_PATH})
 # Add target to generate docstrings
 if (DEPTHAI_PYTHON_BUILD_DOCSTRINGS)
     include(pybind11-mkdoc)
 
     # Check if pybind11_mkdoc available and create target
-    target_pybind11_mkdoc_setup(${DEPTHAI_PYTHON_DOCSTRINGS_OUTPUT} depthai::core ${DEPTHAI_PYTHON_FORCE_DOCSTRINGS})
+    target_pybind11_mkdoc_setup(${docstring_output_path} depthai::core ${DEPTHAI_PYTHON_FORCE_DOCSTRINGS})
 
     if(NOT TARGET pybind11_mkdoc)
         # Generate default docstrings to OUTPUT path
-        configure_file(cmake/default_docstring.hpp.in ${DEPTHAI_PYTHON_DOCSTRINGS_OUTPUT} COPYONLY)
+        configure_file(cmake/default_docstring.hpp.in ${docstring_output_path} COPYONLY)
     endif()
 else()
     # Generate default docstrings to OUTPUT path
-    configure_file(cmake/default_docstring.hpp.in ${DEPTHAI_PYTHON_DOCSTRINGS_OUTPUT} COPYONLY)
+    configure_file(cmake/default_docstring.hpp.in ${docstring_output_path} COPYONLY)
 endif()
 
 # Add include directory

README.md

@@ -34,15 +34,22 @@ See: [depthai-core dependencies](https://github.com/luxonis/depthai-core#depende
 To build a shared library from source perform the following:
 ```
 mkdir build && cd build
-cmake ..
+cmake .. [-D PYTHON_EXECUTABLE=/full/path/to/python]
 cmake --build . --parallel
 ```
 
+Where `-D PYTHON_EXECUTABLE` option can optionally specify an exact Python executable to use for building.
+
 To build a wheel, execute the following
 ```
 python3 -m pip wheel . -w wheelhouse
 ```
 
+To build and install using pip:
+```
+python3 -m pip install .
+```
+
 ## Running tests
 
 To run the tests build the library with the following options

cmake/docstring.hpp.in

@@ -1 +1 @@
-#include "@DEPTHAI_PYTHON_DOCSTRINGS_INPUT@"
+#include "@docstring_input_path@"

depthai-core

@@ -2,7 +2,7 @@
 
 set -e
 
-cmake --build build --parallel --target sphinx
+cmake --build build --target sphinx --parallel
 
 # fix missing index.css file
 cp /app/docs/source/_static/css/* /app/build/docs/sphinx/_static/css

docs/docker/update_docs.sh

@@ -90,7 +90,6 @@ Now, pick a tutorial or code sample and start utilizing Gen2 capabilities
    samples/16_device_queue_event.rst
    samples/17_video_mobilenet.rst
    samples/18_rgb_encoding_mobilenet.rst
-   samples/21_mobilenet_decoding_on_device.rst
    samples/22_1_tiny_yolo_v3_decoding_on_device.rst
    samples/22_2_tiny_yolo_v4_decoding_on_device.rst
    samples/23_autoexposure_roi.rst

docs/source/index.rst

@@ -16,14 +16,14 @@ Supported Platforms
 
 We keep up-to-date, pre-compiled, libraries for the following platforms.  Note that a new change is that for Ubuntu now also work unchanged for the Jetson/Xavier series:
 
-======================== =========================================== ================================================= ================================================================================
-Platform                 Instructions                                Tutorial                                          Support
-======================== =========================================== ================================================= ================================================================================
-Windows 10               :ref:`Platform dependencies <Windows>`      `Video tutorial <https://youtu.be/ekopKJfcWiE>`__ `Discord <https://discord.com/channels/790680891252932659/798284448323731456>`__
-macOS                    :ref:`Platform dependencies <macOS>`        `Video tutorial <https://youtu.be/0RGmmjed3Hc>`__ `Discord <https://discord.com/channels/790680891252932659/798283911989690368>`__
-Ubuntu & Jetson/Xavier   :ref:`Platform dependencies <Ubuntu>`       `Video tutorial <https://youtu.be/QXeXMaxj4cM>`__ `Discord <https://discord.com/channels/790680891252932659/798302162160451594>`__
-Raspberry Pi             :ref:`Platform dependencies <Raspberry Pi>` `Video tutorial <https://youtu.be/BpUMT-xqwqE>`__ `Discord <https://discord.com/channels/790680891252932659/798302708070350859>`__
-======================== =========================================== ================================================= ================================================================================
+======================== ============================================== ================================================================================
+Platform                 Instructions                                   Support
+======================== ============================================== ================================================================================
+Windows 10               :ref:`Platform dependencies <Windows>`         `Discord <https://discord.com/channels/790680891252932659/798284448323731456>`__
+macOS                    :ref:`Platform dependencies <macOS>`           `Discord <https://discord.com/channels/790680891252932659/798283911989690368>`__
+Ubuntu & Jetson/Xavier   :ref:`Platform dependencies <Ubuntu>`          `Discord <https://discord.com/channels/790680891252932659/798302162160451594>`__
+Raspberry Pi OS          :ref:`Platform dependencies <Raspberry Pi OS>` `Discord <https://discord.com/channels/790680891252932659/798302708070350859>`__
+======================== ============================================== ================================================================================
 
 And the following platforms are also supported by a combination of the community and Luxonis.
 

docs/source/install.rst

@@ -9,7 +9,7 @@ encoded video over XLINK to the host, saving it to disk as a video file.
 Pressing Ctrl+C will stop the recording and then convert it using ffmpeg into an mp4 to make it
 playable. Note that ffmpeg will need to be installed and runnable for the conversion to mp4 to succeed.
 
-Be careful, this example saves encoded video to your host storage. So if you leave them running,
+Be careful, this example saves encoded video to your host storage. So if you leave it running,
 you could fill up your storage on your host.