From 1bdb9313bec2c0e8ca0d14278a78644f37dcba59 Mon Sep 17 00:00:00 2001 From: Sebastian Golebiewski Date: Tue, 20 Feb 2024 15:11:22 +0100 Subject: [PATCH] [DOCS] Update API reference (#22911) Updating API reference with ``openvino`` namespace redesign changes. This PR addresses the following ticket: 117329 --- .../templates/custom-module-template.rst | 6 ++++-- docs/sphinx_setup/api/ie_python_api/api.rst | 6 ++++++ 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/docs/openvino_sphinx_theme/openvino_sphinx_theme/templates/custom-module-template.rst b/docs/openvino_sphinx_theme/openvino_sphinx_theme/templates/custom-module-template.rst index 4af82b697a9..fa60a39f44d 100644 --- a/docs/openvino_sphinx_theme/openvino_sphinx_theme/templates/custom-module-template.rst +++ b/docs/openvino_sphinx_theme/openvino_sphinx_theme/templates/custom-module-template.rst @@ -1,7 +1,7 @@ {{ fullname | escape | underline}} .. automodule:: {{ fullname }} - + {% block attributes %} {% if attributes %} .. rubric:: Module Attributes @@ -21,7 +21,9 @@ .. autosummary:: :toctree: {% for func in functions %} - {{ func }} + {% if not func.startswith('_') %} + {{ func }} + {% endif %} {%- endfor %} {% endif %} {% endblock %} diff --git a/docs/sphinx_setup/api/ie_python_api/api.rst b/docs/sphinx_setup/api/ie_python_api/api.rst index ff41d6ef3a4..9ef3598355c 100644 --- a/docs/sphinx_setup/api/ie_python_api/api.rst +++ b/docs/sphinx_setup/api/ie_python_api/api.rst @@ -5,6 +5,12 @@ OpenVINO Python API :description: Explore Python API and implementation of its features in Intel® Distribution of OpenVINO™ Toolkit. +.. autosummary:: + :toctree: _autosummary + :template: custom-module-template.rst + + openvino + .. autosummary:: :toctree: _autosummary :template: custom-module-template.rst