Initial scaffold

Signed-off-by: Ashwin Vaidya <[email protected]>

Author: ashwinvaidya17

.gitignore

@@ -135,3 +135,8 @@ dmypy.json
 
 # Pyre type checker
 .pyre/
+
+# Sphinx documentation
+docs/build/
+docs/build_cpp/
+docs/source/_build/

Doxyfile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/Makefile

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/make.bat

@@ -0,0 +1,10 @@
+myst-parser
+nbsphinx
+pandoc
+sphinx
+sphinx_autodoc_typehints
+sphinx_book_theme
+sphinx-copybutton
+sphinx_design
+breathe
+graphviz

docs/requirements.txt

@@ -0,0 +1,56 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+import sys
+from pathlib import Path
+
+# Define the path to your module using Path
+module_path = Path(__file__).parent.parent / "model_api" / "python"
+
+# Insert the path to sys.path
+sys.path.insert(0, str(module_path.resolve()))
+
+project = 'InferenceSDK'
+copyright = '2024, Intel OpenVINO'
+author = 'Intel OpenVINO'
+release = '2024'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    "breathe",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.mathjax",
+    "sphinx_design",
+    "myst_parser",
+    "nbsphinx",
+    "sphinx.ext.napoleon",
+    "sphinx_autodoc_typehints",
+    "sphinx_copybutton",
+    "sphinx.ext.graphviz"
+]
+
+templates_path = ['_templates']
+exclude_patterns = []
+
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = "sphinx_book_theme"
+html_static_path = ['_static']
+html_theme_options = {
+    "logo": {
+        "text": "InferenceSDK",
+    },
+}
+
+breathe_projects = {"InferenceSDK":  Path(__file__).parent.parent/"build_cpp"/ "xml"}
+breathe_default_project = "InferenceSDK"

docs/source/conf.py

@@ -0,0 +1,22 @@
+# InferenceSDK Documentation
+
+```{attention}
+WIP
+```
+
+```{eval-rst}
+.. doxygenindex::
+   :project: InferenceSDK
+   :path: ...
+   :outline:
+   :no-link:
+   :allow-dot-graphs:
+```
+
+```{eval-rst}
+.. automodule:: model_api.models
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+```