diff --git a/.gitignore b/.gitignore index a4d5942c588d7d..2815d16cf28392 100644 --- a/.gitignore +++ b/.gitignore @@ -28,6 +28,7 @@ temp/ CMakeLists.txt.user docs/IE_PLUGIN_DG/html/ CMakeUserPresets.json +venv *.project *.cproject @@ -73,4 +74,4 @@ coverage /src/plugins/intel_cpu/tools/commit_slider/*.json /src/plugins/intel_cpu/tools/commit_slider/slider_cache/* /src/plugins/intel_cpu/thirdparty/ComputeLibrary/build/* -.github/GITHUB_OUTPUT +.github/GITHUB_OUTPUT \ No newline at end of file diff --git a/CMakeLists.txt b/CMakeLists.txt index 70987f39997d2b..be53a53a9b5322 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -165,4 +165,4 @@ endif() # provides a callback function to describe each component in repo include(cmake/packaging/packaging.cmake) -ov_cpack(${OV_CPACK_COMPONENTS_ALL}) +ov_cpack(${OV_CPACK_COMPONENTS_ALL}) \ No newline at end of file diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt index 24552d43bde2ac..8b57988ca14631 100644 --- a/docs/CMakeLists.txt +++ b/docs/CMakeLists.txt @@ -31,6 +31,7 @@ function(build_docs) set(ARTICLES_HELPER_SCRIPT "${SCRIPTS_DIR}/articles_helper.py") set(COPY_IMAGES_SCRIPT "${SCRIPTS_DIR}/copy_images.py") set(DOXYGEN_MAPPING_SCRIPT "${SCRIPTS_DIR}/create_mapping.py") + set(DOCS_MAPPING_SCRIPT "${SCRIPTS_DIR}/create_doc_mapping.py") set(BREATHE_APIDOC_SCRIPT "${SCRIPTS_DIR}/apidoc.py") # Doxygen/Sphinx setup @@ -107,6 +108,7 @@ function(build_docs) POST_BUILD COMMAND ${Python3_EXECUTABLE} ${COPY_IMAGES_SCRIPT} ${DOXYGEN_XML_OUTPUT} ${SPHINX_SOURCE_DIR} COMMAND ${Python3_EXECUTABLE} ${DOXYGEN_MAPPING_SCRIPT} ${DOXYGEN_XML_OUTPUT} ${DOCS_BUILD_DIR} ${OpenVINO_SOURCE_DIR}/../ + COMMAND ${Python3_EXECUTABLE} ${DOCS_MAPPING_SCRIPT} ${DOCS_BUILD_DIR} ${ARTICLES_EN_DIR} COMMAND ${CMAKE_COMMAND} -E copy_directory ${SPHINX_SETUP_DIR} ${SPHINX_SOURCE_DIR} ${post_commands} VERBATIM) diff --git a/docs/home.rst b/docs/home.rst deleted file mode 100644 index 96a64e2a990af3..00000000000000 --- a/docs/home.rst +++ /dev/null @@ -1,186 +0,0 @@ -============================ -OpenVINO 2024.0 -============================ - -.. meta:: - :google-site-verification: _YqumYQ98cmXUTwtzM_0WIIadtDc6r_TMYGbmGgNvrk - -**OpenVINO is an open-source toolkit** for optimizing and deploying deep learning models from cloud -to edge. It accelerates deep learning inference across various use cases, such as generative AI, video, -audio, and language with models from popular frameworks like PyTorch, TensorFlow, ONNX, and more. -Convert and optimize models, and deploy across a mix of Intel® hardware and environments, on-premises -and on-device, in the browser or in the cloud. - -Check out the `OpenVINO Cheat Sheet. `__ - - -.. container:: - :name: ov-homepage-banner - - .. raw:: html - - -
-
-
-
    -
  • -

    An open-source toolkit for optimizing and deploying deep learning models.

    -

    Boost your AI deep-learning inference performance!

    - Learn more -
  • -
  • -

    Better OpenVINO integration with PyTorch!

    -

    Use PyTorch models directly, without converting them first.

    - Learn more -
  • -
  • -

    OpenVINO via PyTorch 2.0 torch.compile()

    -

    Use OpenVINO directly in PyTorch-native applications!

    - Learn more -
  • -
  • -

    Do you like Generative AI?

    -

    You will love how it performs with OpenVINO!

    - Check out our new notebooks -
  • -
  • -

    Boost your AI deep-learning inference performance.

    -

    Use Intel's open-source OpenVINO toolkit for optimizing and deploying deep learning models.

    - Learn more -
  • -
-
-
-
- -| -| - -.. image:: _static/images/openvino-overview-diagram.jpg - :align: center - :alt: openvino diagram - -| - -Places to Begin -++++++++++++++++++++++++++++ - -.. grid:: 2 2 3 3 - :class-container: ov-homepage-higlight-grid - - .. grid-item-card:: Installation - :img-top: ./_static/images/home_begin_tile_01.png - :class-card: homepage_begin_tile - - This guide introduces installation and learning materials for Intel® Distribution of OpenVINO™ toolkit. - - .. button-link:: get-started/install-openvino.html - :color: primary - :outline: - - Get Started - - .. grid-item-card:: Performance Benchmarks - :img-top: ./_static/images/home_begin_tile_02.png - :class-card: homepage_begin_tile - - See latest benchmark numbers for OpenVINO and OpenVINO Model Server. - - .. button-link:: about-openvino/performance-benchmarks.html - :color: primary - :outline: - - View data - - .. grid-item-card:: Framework Compatibility - :img-top: ./_static/images/home_begin_tile_03.png - :class-card: homepage_begin_tile - - Load models directly (for TensorFlow, ONNX, PaddlePaddle) or convert to OpenVINO format. - - .. button-link:: openvino-workflow/model-preparation.html - :color: primary - :outline: - - Load your model - - .. grid-item-card:: Easy Deployment - :img-top: ./_static/images/home_begin_tile_04.png - :class-card: homepage_begin_tile - - Get started in just a few lines of code. - - .. button-link:: openvino-workflow/running-inference.html - :color: primary - :outline: - - Run Inference - - .. grid-item-card:: Serving at scale - :img-top: ./_static/images/home_begin_tile_05.png - :class-card: homepage_begin_tile - - Cloud-ready deployments for microservice applications. - - .. button-link:: openvino-workflow/running-inference.html - :color: primary - :outline: - - Try it out - - .. grid-item-card:: Model Compression - :img-top: ./_static/images/home_begin_tile_06.png - :class-card: homepage_begin_tile - - Reach for performance with post-training and training-time compression with NNCF. - - .. button-link:: openvino-workflow/model-optimization.html - :color: primary - :outline: - - Optimize now - -| - -Key Features -++++++++++++++++++++++++++++ - - -.. grid:: 2 2 2 2 - :class-container: homepage_begin_container - - .. grid-item-card:: Model Compression - :img-top: ./_static/images/home_key_feature_01.png - :class-card: homepage_begin_key - - You can either link directly with OpenVINO Runtime to run inference locally or use OpenVINO Model Server to serve model inference from a separate server or within a Kubernetes environment. - - .. grid-item-card:: Fast & Scalable Deployment - :img-top: ./_static/images/home_key_feature_02.png - :class-card: homepage_begin_key - - Write an application once, deploy it anywhere, achieving maximum performance from hardware. Automatic device discovery allows for superior deployment flexibility. OpenVINO Runtime supports Linux, Windows, and MacOS and provides Python, C++, and C API. Use your preferred language and OS. - - .. grid-item-card:: Lighter Deployment - :img-top: ./_static/images/home_key_feature_03.png - :class-card: homepage_begin_key - - Designed with minimal external dependencies reduces the application footprint, simplifying installation and dependency management. Popular package managers enable application dependencies to be easily installed and upgraded. Custom compilation for your specific model(s) further reduces the final binary size. - - .. grid-item-card:: Enhanced App Start-Up Time - :img-top: ./_static/images/home_key_feature_04.png - :class-card: homepage_begin_key - - In applications where fast start-up is required, OpenVINO significantly reduces first-inference latency by using the CPU for initial inference and then switching to another device once the model has been compiled and loaded to memory. Compiled models are cached, improving start-up time even more. - - -.. toctree:: - :maxdepth: 2 - :hidden: - - GET STARTED - LEARN OPENVINO - OPENVINO WORKFLOW - DOCUMENTATION - ABOUT OPENVINO \ No newline at end of file diff --git a/docs/index.html b/docs/index.html deleted file mode 100644 index 2e615a41d77a30..00000000000000 --- a/docs/index.html +++ /dev/null @@ -1 +0,0 @@ - diff --git a/docs/openvino_custom_sphinx_sitemap/openvino_custom_sphinx_sitemap/__init__.py b/docs/openvino_custom_sphinx_sitemap/openvino_custom_sphinx_sitemap/__init__.py index fdbb002e1a9601..25b1c954043e9d 100644 --- a/docs/openvino_custom_sphinx_sitemap/openvino_custom_sphinx_sitemap/__init__.py +++ b/docs/openvino_custom_sphinx_sitemap/openvino_custom_sphinx_sitemap/__init__.py @@ -1,6 +1,10 @@ import xml.etree.ElementTree as ET -from sphinx_sitemap import setup as base_setup, get_locales, hreflang_formatter +import queue +from pathlib import Path +from sphinx_sitemap import setup as base_setup, get_locales, hreflang_formatter, add_html_link, record_builder_type +from sphinx.util.logging import getLogger +logger = getLogger(__name__) def setup(app): app.add_config_value( @@ -19,7 +23,9 @@ def setup(app): for listener in app.events.listeners['build-finished']: if listener.handler.__name__ == 'create_sitemap': app.disconnect(listener.id) - + + app.connect("builder-inited", record_builder_type) + app.connect("html-page-context", add_html_link) app.connect('build-finished', create_sitemap) return setup @@ -30,11 +36,15 @@ def create_sitemap(app, exception): urlset = app.builder.config.ov_sitemap_urlset meta = app.builder.config.ov_sitemap_meta - site_url = app.builder.config.site_url - site_url = site_url.rstrip('/') + '/' - if not site_url: - print("sphinx-sitemap error: no site_url" - "are set in conf.py. Sitemap not built.") + site_url = app.builder.config.site_url or app.builder.config.html_baseurl + if site_url: + site_url.rstrip("/") + "/" + else: + logger.warning( + "sphinx-sitemap: html_baseurl is required in conf.py." "Sitemap not built.", + type="sitemap", + subtype="configuration", + ) return if (not app.sitemap_links): print("sphinx-sitemap warning: No pages generated for %s" % @@ -51,7 +61,7 @@ def create_sitemap(app, exception): for item in urlset: root.set(*item) - get_locales(app, exception) + locales = get_locales(app, exception) if app.builder.config.version: version = app.builder.config.version + '/' @@ -78,7 +88,7 @@ def create_sitemap(app, exception): ET.SubElement(namespace_element, tag_name).text = tag_value if len(app.locales) > 0: - for lang in app.locales: + for lang in locales: lang = lang + '/' linktag = ET.SubElement( url, @@ -90,10 +100,10 @@ def create_sitemap(app, exception): lang=lang, version=version, link=link )) - filename = app.outdir + "/" + app.config.sitemap_filename + filename = Path(app.outdir) / app.config.sitemap_filename ET.ElementTree(root).write(filename, xml_declaration=True, encoding='utf-8', method="xml") print("%s was generated for URL %s in %s" % (app.config.sitemap_filename, - site_url, filename)) + site_url, filename)) \ No newline at end of file diff --git a/docs/openvino_sphinx_theme/openvino_sphinx_theme/__init__.py b/docs/openvino_sphinx_theme/openvino_sphinx_theme/__init__.py index eed2e43c047ab6..3d2a792ce8956a 100644 --- a/docs/openvino_sphinx_theme/openvino_sphinx_theme/__init__.py +++ b/docs/openvino_sphinx_theme/openvino_sphinx_theme/__init__.py @@ -1,15 +1,13 @@ import os -import sys import json +import sys from json import JSONDecodeError from sphinx.errors import ExtensionError import jinja2 from docutils.parsers import rst from pathlib import Path -from bs4 import BeautifulSoup from sphinx.util import logging -from pydata_sphinx_theme import index_toctree -from .directives.code import DoxygenSnippet, Scrollbox, Nodescrollbox, visit_scrollbox, depart_scrollbox, Showcase, Nodeshowcase, visit_showcase, depart_showcase +from .directives.code import DoxygenSnippet, Scrollbox, Nodescrollbox, visit_scrollbox, depart_scrollbox SPHINX_LOGGER = logging.getLogger(__name__) @@ -18,9 +16,8 @@ def setup_edit_url(app, pagename, templatename, context, doctree): """Add a function that jinja can access for returning the edit URL of a page.""" def has_github_page(): - doxygen_mapping_file = app.config.html_context.get('doxygen_mapping_file') - name = pagename.rsplit('-')[0] - if name in doxygen_mapping_file: + doxygen_mapping_file = app.config.doxygen_mapping_file + if os.path.basename(pagename) in doxygen_mapping_file: return True return False @@ -29,11 +26,6 @@ def get_edit_url(): doc_context = dict() doc_context.update(**context) - # Make sure that doc_path has a path separator only if it exists (to avoid //) - doc_path = doc_context.get("doc_path", "") - if doc_path and not doc_path.endswith("/"): - doc_path = f"{doc_path}/" - # ensure custom URL is checked first, if given url_template = doc_context.get("edit_page_url_template") @@ -47,15 +39,15 @@ def get_edit_url(): return jinja2.Template(url_template).render(**doc_context) url_template = '{{ github_url }}/{{ github_user }}/{{ github_repo }}' \ - '/edit/{{ github_version }}/{{ doc_path }}{{ file_name }}' + '/edit/{{ github_version }}/{{ file_name }}' - doxygen_mapping_file = app.config.html_context.get('doxygen_mapping_file') - rst_name = pagename.rsplit('-')[0] + doxygen_mapping_file = app.config.doxygen_mapping_file + rst_name = os.path.basename(pagename) file_name = doxygen_mapping_file[rst_name] parent_folder = Path(os.path.dirname(file_name)).parts[0] file_name = Path(*Path(file_name).parts[1:]).as_posix() - doc_context.update(doc_path=doc_path, file_name=file_name) + doc_context.update(file_name=file_name) try: repositories = app.config.repositories except AttributeError: @@ -87,118 +79,6 @@ def get_theme_path(): return theme_path -def add_toctree_functions(app, pagename, templatename, context, doctree): - - # override pydata_sphinx_theme - def generate_sidebar_nav(kind, startdepth=None, **kwargs): - """ - Return the navigation link structure in HTML. Arguments are passed - to Sphinx "toctree" function (context["toctree"] below). - - We use beautifulsoup to add the right CSS classes / structure for bootstrap. - - See https://www.sphinx-doc.org/en/master/templating.html#toctree. - - Parameters - ---------- - kind : ["navbar", "sidebar", "raw"] - The kind of UI element this toctree is generated for. - startdepth : int - The level of the toctree at which to start. By default, for - the navbar uses the normal toctree (`startdepth=0`), and for - the sidebar starts from the second level (`startdepth=1`). - kwargs: passed to the Sphinx `toctree` template function. - - Returns - ------- - HTML string (if kind in ["navbar", "sidebar"]) - or BeautifulSoup object (if kind == "raw") - """ - - open_first = False - if 'open_first' in kwargs: - open_first = kwargs.pop('open_first') - - if startdepth is None: - startdepth = 1 if kind == "sidebar" else 0 - - if startdepth == 0: - toc_sphinx = context["toctree"](**kwargs) - else: - # select the "active" subset of the navigation tree for the sidebar - toc_sphinx = index_toctree(app, pagename, startdepth, **kwargs) - - soup = BeautifulSoup(toc_sphinx, "html.parser") - - if kind == "sidebar": - # Add bootstrap classes for first `ul` items - for ul in soup("ul", recursive=False): - ul.attrs["class"] = ul.attrs.get("class", []) + ["nav", "bd-sidenav"] - - toctree_checkbox_count = 0 - - for li in soup.find_all("li"): - # pair "current" with "active" since that's what we use w/ bootstrap - if "current" in li["class"]: - li["class"].append("active") - - # Remove navbar/sidebar links to sub-headers on the page - if li.find("a"): - href = li.find("a")["href"] - if "#" in href and href != "#": - li.decompose() - continue - - if kind == "navbar": - li["class"].append("nav-item") - li.find("a")["class"].append("nav-link") - # only select li items (not eg captions) - # out = "\n".join([ii.prettify() for ii in soup.find_all("li")]) - elif kind == "sidebar": - if li is None: - continue - # We check all "li" elements, to add a "current-page" to the correct li. - classes = li.get("class", []) - - # Nothing more to do, unless this has "children" - if not li.find("ul"): - continue - - # Add a class to indicate that this has children. - li["class"] = classes + ["has-children"] - - # We're gonna add a checkbox. - toctree_checkbox_count += 1 - checkbox_name = f"toctree-checkbox-{toctree_checkbox_count}" - - # Add the "label" for the checkbox which will get filled. - if soup.new_tag is None: - continue - label = soup.new_tag("label", attrs={"for": checkbox_name}) - label.append(soup.new_tag("i", attrs={"class": "fas fa-chevron-down"})) - li.insert(1, label) - - # Add the checkbox that's used to store expanded/collapsed state. - checkbox = soup.new_tag( - "input", - attrs={ - "type": "checkbox", - "class": ["toctree-checkbox"], - "id": checkbox_name, - "name": checkbox_name, - }, - ) - # if this has a "current" class, be expanded by default - # (by checking the checkbox) - if "current" in classes or (open_first and toctree_checkbox_count == 1): - checkbox.attrs["checked"] = "" - li.insert(1, checkbox) - - return soup - - context["generate_sidebar_nav"] = generate_sidebar_nav - - def read_doxygen_configs(app, env, docnames): if app.config.html_context.get('doxygen_mapping_file'): try: @@ -215,20 +95,13 @@ def setup(app): app.config.templates_path.append(templates_path) app.config.html_static_path.append(static_path) app.connect("html-page-context", setup_edit_url, priority=sys.maxsize) - app.connect("html-page-context", add_toctree_functions) app.connect('env-before-read-docs', read_doxygen_configs) app.add_html_theme('openvino_sphinx_theme', theme_path) rst.directives.register_directive('doxygensnippet', DoxygenSnippet) rst.directives.register_directive('scrollbox', Scrollbox) - rst.directives.register_directive('showcase', Showcase) app.add_node( Nodescrollbox, html=(visit_scrollbox, depart_scrollbox), latex=(visit_scrollbox, depart_scrollbox) ) - app.add_node( - Nodeshowcase, - html=(visit_showcase, depart_showcase), - latex=(visit_showcase, depart_showcase) - ) return {'parallel_read_safe': True, 'parallel_write_safe': True} diff --git a/docs/openvino_sphinx_theme/openvino_sphinx_theme/directives/code.py b/docs/openvino_sphinx_theme/openvino_sphinx_theme/directives/code.py index 47daa5c70e303d..788d7ea35d2736 100644 --- a/docs/openvino_sphinx_theme/openvino_sphinx_theme/directives/code.py +++ b/docs/openvino_sphinx_theme/openvino_sphinx_theme/directives/code.py @@ -249,4 +249,4 @@ def run(self): self.add_name(node) if self.content: self.state.nested_parse(self.content, self.content_offset, node) - return [node] + return [node] \ No newline at end of file diff --git a/docs/openvino_sphinx_theme/openvino_sphinx_theme/static/css/openvino_sphinx_theme.css b/docs/openvino_sphinx_theme/openvino_sphinx_theme/static/css/openvino_sphinx_theme.css index 89311f190436d7..b180a5a096eaf3 100644 --- a/docs/openvino_sphinx_theme/openvino_sphinx_theme/static/css/openvino_sphinx_theme.css +++ b/docs/openvino_sphinx_theme/openvino_sphinx_theme/static/css/openvino_sphinx_theme.css @@ -24,13 +24,13 @@ --ost-color-sst-dropdown-background:var(--ost-color-navbar-background); --ost-color-sst-dropdown-background-active:var(--ost-color-primary-variant); /* Override Pydata Sphinx Theme Variables */ - --pst-font-family-base: var(--ost-font-family), var(--pst-font-family-base-system); --pst-font-family-heading: var(--ost-font-family), var(--pst-font-family-base-system); --pst-font-size-base: var(--ost-font-size); --pst-color-sidebar-link-active: var(--ost-color-sidebar-link-active); --pst-color-sidebar-link-hover: var(--ost-color-sidebar-link-hover); --pst-color-sidebar-link: var(--ost-color-sidebar-link); --pst-color-primary: var(--ost-color-primary); + --pst-color-secondary: var(--ost-color-primary)!important; --pst-color-link: var(--ost-color-link); --pst-color-link-hover: var(--ost-color-link-hover); --tabs--label-text--active: var(--ost-tabs--label-text--active); @@ -47,7 +47,7 @@ body { } .bd-sidebar .nav .active > a { - font-weight: 600!important; + font-weight: 700!important; } .toc-entry >.nav-link.active { @@ -55,138 +55,6 @@ body { border-color: rgb(var(--ost-color-primary)); } -/* Showcase Extension */ - -:root { - /* Showcase - Colors */ - --ov-color: hsl(261, 87.2%, 54.1%); - --black: hsl(0, 0%, 0%); - --white: hsl(0, 0%, 100%); - --ov-light-blue: rgba(229, 242, 255, 0.95); - --ov-blue: rgba(0, 104, 181, 0.95); - --ov-dark-blue: rgba(0, 74, 134, 0.95); - } - - .showcase-wrap { - width: 100%; - display: inline-block; - margin: 10px 10px 30px 10px; - - } - - .showcase { - width: 100%; - min-height: 150px; - vertical-align: top; - } - - .showcase-content { - min-height: inherit; - width: -webkit-calc(100% - 160px); - width: -moz-calc(100% - 160px); - width: calc(100% - 160px); - padding: 0.5rem 1.2rem 0.5rem; - display: inline-block; - position: relative; - - } - .showcase-content::after { - content: ""; - position: absolute; - height: 0.15rem; - width: 100%; - bottom: 0px; - left: 0px; - background-color: var(--ov-light-blue); - } - - .showcase-img { - object-fit: cover; - width: 150px; - height: 150px; - position: absolute; - border-radius: 0.25rem; - box-shadow: 0.25rem 0.25rem 0.5rem rgba(0,0,0,0.25); - border: 1px solid rgba(0, 0, 0, 0.25); - } - - .showcase-img-placeholder { - min-height: 150px; - width: 150px; - text-align: left; - vertical-align: top; - display: inline-block; - position: relative; - margin-right: 10px; - } - - .showcase-title { - font-size: 0.90rem; - line-height: 1; - margin: 0px 0px 10px 0px; - color: var(--black); - position: relative; - width: fit-content; - width: -moz-fit-content; - } - - .showcase-title::after { - content: ""; - position: absolute; - height: 0.15rem; - width: 100%; - bottom: -5px; - left: 0px; - background-color: var(--ov-light-blue); - } - - .showcase-content-container p { - font-size: 1.2rem; - line-height: 1.2; - color: var(--black); - position: relative; - } - - .showcase-content-container a > h2 { - display: block!important; - width: fit-content; - width: -moz-fit-content; - } - - .showcase-badge { - margin-right: 3px; - } - - .showcase-button { - width: 100px; - float: right; - border: none; - font-size: 1rem; - color: #00A3F6; - background-color: #FFF; - position: absolute; - right: 0px; - bottom: 0px; - } - - .showcase-button:focus { - outline: none!important; - } - - .showcase-button:hover { - text-decoration: underline; - } - - .showcase-badge:hover, .showcase-img:hover { - transform: scale(1.05); - } - - .showcase-img:hover { - box-shadow: 0 0 10px 2px rgba(108,36,240,0.3) !important; - } - - - /* Scrollbox Extension */ .scrollbox { @@ -279,7 +147,6 @@ blockquote p { /* Edit this page */ .editthispage { - text-align: end; padding-top:0; } @@ -332,6 +199,7 @@ blockquote p { .navbar { background:rgba(var(--ost-color-navbar-background), 1) !important; + height: 60px; } .navbar-light .navbar-nav li a.nav-link { @@ -361,10 +229,6 @@ blockquote p { flex-wrap: wrap; } - .navbar-nav { - flex-direction: column !important; - } - .container-xl { display: block; } diff --git a/docs/openvino_sphinx_theme/openvino_sphinx_theme/templates/custom-class-template.rst b/docs/openvino_sphinx_theme/openvino_sphinx_theme/templates/custom-class-template.rst deleted file mode 100644 index 710766c8aaed15..00000000000000 --- a/docs/openvino_sphinx_theme/openvino_sphinx_theme/templates/custom-class-template.rst +++ /dev/null @@ -1,32 +0,0 @@ -{{ fullname | escape | underline}} - -.. currentmodule:: {{ module }} - -.. autoclass:: {{ objname }} - :members: - :show-inheritance: - :inherited-members: - - {% block methods %} - .. automethod:: __init__ - - {% if methods %} - .. rubric:: Methods - - .. autosummary:: - {% for met in methods %} - ~{{ name }}.{{ met }} - {%- endfor %} - {% endif %} - {% endblock %} - - {% block attributes %} - {% if attributes %} - .. rubric:: Attributes - - .. autosummary:: - {% for att in attributes %} - ~{{ name }}.{{ att }} - {%- endfor %} - {% endif %} - {% endblock %} 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 deleted file mode 100644 index fa60a39f44d8df..00000000000000 --- a/docs/openvino_sphinx_theme/openvino_sphinx_theme/templates/custom-module-template.rst +++ /dev/null @@ -1,68 +0,0 @@ -{{ fullname | escape | underline}} - -.. automodule:: {{ fullname }} - -{% block attributes %} -{% if attributes %} - .. rubric:: Module Attributes - - .. autosummary:: - :toctree: - {% for attr in attributes %} - {{ attr }} - {% endfor %} -{% endif %} -{% endblock %} - -{% block functions %} -{% if functions %} - .. rubric:: Functions - - .. autosummary:: - :toctree: - {% for func in functions %} - {% if not func.startswith('_') %} - {{ func }} - {% endif %} - {%- endfor %} -{% endif %} -{% endblock %} - -{% block classes %} -{% if classes %} - .. rubric:: Classes - - .. autosummary:: - :toctree: - :template: custom-class-template.rst - {% for cl in classes %} - {{ cl }} - {%- endfor %} -{% endif %} -{% endblock %} - -{% block exceptions %} -{% if exceptions %} - .. rubric:: Exceptions - - .. autosummary:: - :toctree: - {% for item in exceptions %} - {{ item }} - {%- endfor %} -{% endif %} -{% endblock %} - -{% block modules %} -{% if modules %} -.. rubric:: Modules - -.. autosummary:: - :toctree: - :template: custom-module-template.rst - :recursive: -{% for mod in modules %} - {{ mod }} -{%- endfor %} -{% endif %} -{% endblock %} diff --git a/docs/openvino_sphinx_theme/openvino_sphinx_theme/templates/download-docs.html b/docs/openvino_sphinx_theme/openvino_sphinx_theme/templates/download-docs.html index 9df1ef99c2333d..d7a8d3e216fb9e 100644 --- a/docs/openvino_sphinx_theme/openvino_sphinx_theme/templates/download-docs.html +++ b/docs/openvino_sphinx_theme/openvino_sphinx_theme/templates/download-docs.html @@ -1,6 +1,6 @@