add ote repo (#10979)

docs/CMakeLists.txt

@@ -46,6 +46,7 @@ endif()
 set(LINKCHECKER_PY "" CACHE FILEPATH "Path to linkchecker.py for documentation check dir.")
 set(ENABLE_OPENVINO_NOTEBOOKS OFF CACHE BOOL "Build with openvino notebooks")
 set(OMZ_DOCS_DIR "" CACHE PATH "Path to open_model_zoo documentation dir.")
+set(OTE_DOCS_DIR "" CACHE PATH "Path to training_extensions documentation dir.")
 set(WORKBENCH_DOCS_DIR "" CACHE PATH "Path to workbench documentation dir.")
 set(OVMS_DOCS_DIR "" CACHE PATH "Path to model server documentation dir.")
 set(GRAPH_CSV_DIR "" CACHE PATH "Path to the folder containing csv data for rendering graphs.")
@@ -159,6 +160,15 @@ function(build_docs)
             --output_dir=${DOCS_BUILD_DIR}/workbench)
     endif()
 
+    # ote doc files
+    if(EXISTS "${OTE_DOCS_DIR}")
+        get_filename_component(WORKBENCH_DOCS_DIR "${OTE_DOCS_DIR}" ABSOLUTE)
+
+        list(APPEND commands COMMAND ${PYTHON_EXECUTABLE} ${DOXY_MD_FILTER}
+            --input_dir=${OTE_DOCS_DIR}
+            --output_dir=${DOCS_BUILD_DIR}/ote)
+    endif()
+
     # ovms doc files
     if(EXISTS "${OVMS_DOCS_DIR}")
         get_filename_component(OVMS_DOCS_DIR "${OVMS_DOCS_DIR}" ABSOLUTE)

docs/conf.py

@@ -104,6 +104,12 @@ repositories = {
         'github_version': 'master',
         'host_url': 'https://github.com'
     },
+    'ote': {
+        'github_user': 'openvinotoolkit',
+        'github_repo': 'training_extensions',
+        'github_version': 'develop',
+        'host_url': 'https://github.com'
+    },
     'open_model_zoo': {
         'github_user': 'openvinotoolkit',
         'github_repo': 'open_model_zoo',

docs/documentation.md

@@ -61,6 +61,7 @@
    :hidden:
 
    ovms_what_is_openvino_model_server
+   ote_documentation
    ovsa_get_started
 
 .. toctree::

docs/scripts/create_mapping.py

@@ -11,7 +11,8 @@ REPOSITORIES = [
     'openvino',
     'omz',
     'pot'
-    'ovms'
+    'ovms',
+    'ote'
 ]
 
 

docs/scripts/doxy_md_filter.py

@@ -65,7 +65,7 @@ class DoxyMDFilter:
         """
         for link in self.md_links:
             link_path = self.parent_folder.joinpath(link).resolve()
-            if os.path.exists(link_path):
+            if os.path.exists(link_path) and link_path in self.file_to_label_mapping:
                 self.content = self.content.replace(link, '@ref ' + self.file_to_label_mapping[link_path])
             else:
                 rel_path = os.path.relpath(link_path, self.input_dir).replace('\\', '/')

docs/scripts/tests/conftest.py

@@ -72,6 +72,11 @@ def pytest_addoption(parser):
         action="store_true",
         default=False,
         help='Include link check for ovms')
+    parser.addoption(
+        '--include_ote',
+        action="store_true",
+        default=False,
+        help='Include link check for ote')
 
 
 def read_lists(configs):
@@ -90,7 +95,7 @@ def read_lists(configs):
 def pytest_generate_tests(metafunc):
     """ Generate tests depending on command line options
     """
-    exclude_links = {'open_model_zoo', 'workbench', 'pot', 'gst', 'omz', 'ovms'}
+    exclude_links = {'open_model_zoo', 'workbench', 'pot', 'gst', 'omz', 'ovms', 'ote'}
     if metafunc.config.getoption('include_omz'):
         exclude_links.remove('open_model_zoo')
         exclude_links.remove('omz')
@@ -102,6 +107,8 @@ def pytest_generate_tests(metafunc):
         exclude_links.remove('gst')
     if metafunc.config.getoption('include_ovms'):
         exclude_links.remove('ovms')
+    if metafunc.config.getoption('include_ote'):
+        exclude_links.remove('ote')
 
     # warnings to ignore
     suppress_warnings = read_lists(metafunc.config.getoption('suppress_warnings'))