refactor

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

Author: ashwinvaidya17

docs/requirements.txt

@@ -3,7 +3,7 @@ nbsphinx
 pandoc
 sphinx
 sphinx_autodoc_typehints
-sphinx_book_theme
+pydata-sphinx-theme
 sphinx-copybutton
 sphinx_design
 breathe

docs/source/conf.py

@@ -51,9 +51,28 @@
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
-html_theme = "sphinx_book_theme"
+html_theme = "pydata_sphinx_theme"
 html_static_path = ['_static']
 
 breathe_projects = {"InferenceSDK":  Path(__file__).parent.parent/"build_cpp"/ "xml"}
 breathe_default_project = "InferenceSDK"
 breathe_default_members = ('members', 'undoc-members', 'private-members')
+
+autodoc_docstring_signature = True
+autodoc_member_order = "bysource"
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3", None),
+    "numpy": ("https://numpy.org/doc/stable/", None),
+}
+autodoc_member_order = "groupwise"
+autodoc_default_options = {
+    "members": True,
+    "methods": True,
+    "special-members": "__call__",
+    "exclude-members": "_abc_impl",
+    "show-inheritance": True,
+}
+
+autoclass_content = "both"
+
+autosummary_generate = True  # Turn on sphinx.ext.autosummary

docs/source/cpp/adapters/index.md

@@ -1,4 +1,4 @@
-## Adapters
+# Adapters
 
 ```{eval-rst}
 .. doxygenclass:: InferenceAdapter

docs/source/guides/index.md

@@ -0,0 +1,9 @@
+# Guides
+
+```{toctree}
+:caption: Guides
+:hidden:
+
+./model-configuration
+./releasing-to-PyPI
+```

docs/model-configuration.md docs/source/guides/model-configuration.mddocs/model-configuration.md renamed to docs/source/guides/model-configuration.md

@@ -1,3 +1,5 @@
+# Releasing to PyPI
+
 ```bash
 py -m pip install --upgrade build
 # Remove master omz_tools. Will use one from openvino-dev
@@ -7,4 +9,5 @@ py -m twine upload --username __token__ model_api/python/dist/*
 git tag X.Y.Z
 git push upstream X.Y.Z
 ```
+
 Pull request to increment `version` in `pyproject.toml` for the next release.

docs/releasing-to-PyPI.md docs/source/guides/releasing-to-PyPI.mddocs/releasing-to-PyPI.md renamed to docs/source/guides/releasing-to-PyPI.md

@@ -76,12 +76,19 @@ Pipelines description[todo]
 :caption: Python Reference
 :hidden:
 
-python/index
+./python/index
 ```
 
 ```{toctree}
 :caption: C++ Reference
 :hidden:
 
-cpp/index
+./cpp/index
+```
+
+```{toctree}
+:caption: Developer Guides
+:hidden:
+
+./guides/index
 ```

docs/source/index.md

@@ -37,3 +37,14 @@
 :::
 
 ::::
+
+```{toctree}
+:caption: Adapters
+:hidden:
+
+./inference_adapter
+./onnx_adapter
+./openvino_adapter
+./ovms_adapter
+./utils
+```

docs/source/python/adapters/index.md

@@ -35,11 +35,11 @@ Tilers description[todo]
 ::::
 
 ```{toctree}
-:caption: Python Reference
+:caption: Python API Reference
 :hidden:
 
-adapters/index
-models/index
-pipelines/index
-tilers/index
-```
+./adapters/index
+./models/index
+./pipelines/index
+./tilers/index
+```

docs/source/python/index.md

@@ -1,5 +1,9 @@
 # Tilers
 
+::::{grid} 1 2 2 3
+:margin: 1 1 0 0
+:gutter: 1
+
 :::{grid-item-card} Semantic Segmentation
 :link: ./semantic_segmentation
 :link-type: doc
@@ -28,6 +32,8 @@
 [todo]
 :::
 
+::::
+
 ```{toctree}
 :caption: Tilers
 :hidden: