Skip to content

Commit 8151e00

Browse files
[DOCS] technical adjustments for the build mstr (#26883)
1 parent de94a33 commit 8151e00

File tree

3 files changed

+38
-18
lines changed

3 files changed

+38
-18
lines changed

CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ product better.
5252
Since the market of computing devices is constantly evolving, OpenVINO is always open to extending
5353
its support for new hardware. If you want to run inference on a device that is currently not supported,
5454
you can see how to develop a new plugin for it in the
55-
[Plugin Developer Guide](https://docs.openvino.ai/canonical/openvino_docs_ie_plugin_dg_overview.html).
55+
[Plugin Developer Guide](https://docs.openvino.ai/2024/documentation/openvino-extensibility/openvino-plugin-library.html).
5656

5757

5858
### Improve documentation

docs/articles_en/get-started/install-openvino/install-openvino-pip.rst

+34-16
Original file line numberDiff line numberDiff line change
@@ -15,19 +15,7 @@ Install Intel® Distribution of OpenVINO™ Toolkit from PyPI Repository
1515
* is dedicated to users of all major OSes: Windows, Linux, and macOS
1616
(all x86_64 / arm64 architectures)
1717
* macOS offers support only for CPU inference
18-
19-
| **Simplified Build and Integration**
20-
| The package includes CMake configurations, precompiled static libraries, and headers, which
21-
can be easily accessed through the Python API. You can use the `get_cmake_path()` method to
22-
retrieve the paths to the CMake configurations and libraries:
23-
24-
.. code-block:: python
2518

26-
from openvino import get_cmake_path
27-
cmake_path = get_cmake_path()
28-
29-
For detailed instructions on how to use these configurations in your build setup, check out the
30-
:ref:`Create a library with extensions <create_a_library_with_extensions>` section.
3119

3220
.. tab-set::
3321

@@ -42,10 +30,13 @@ For detailed instructions on how to use these configurations in your build setup
4230
.. tab-item:: Processor Notes
4331
:sync: processor-notes
4432

45-
| To see if your processor includes the integrated graphics technology and supports iGPU inference, refer to:
33+
| To see if your processor includes the integrated graphics technology and supports iGPU
34+
inference, refer to:
4635
| `Product Specifications <https://ark.intel.com/>`__
4736
4837

38+
39+
4940
Installing OpenVINO Runtime
5041
###########################
5142

@@ -137,20 +128,47 @@ to see if your case needs any of them.
137128

138129

139130

131+
132+
133+
| **Simplified Build and Integration**
134+
| The package includes CMake configurations, precompiled static libraries, and headers, which
135+
can be easily accessed through the Python API. You can use the `get_cmake_path()` method to
136+
retrieve the paths to the CMake configurations and libraries:
137+
138+
.. code-block:: python
139+
140+
from openvino import get_cmake_path
141+
cmake_path = get_cmake_path()
142+
143+
For detailed instructions on how to use these configurations in your build setup, check out the
144+
:ref:`Create a library with extensions <create_a_library_with_extensions>` section.
145+
146+
147+
148+
149+
150+
151+
140152
What's Next?
141153
####################
142154

143-
Now that you've installed OpenVINO Runtime, you're ready to run your own machine learning applications! Learn more about how to integrate a model in OpenVINO applications by trying out the following tutorials.
155+
Now that you've installed OpenVINO Runtime, you're ready to run your own machine learning
156+
applications! Learn more about how to integrate a model in OpenVINO applications by trying out
157+
the following tutorials.
144158

145159
.. image:: https://user-images.githubusercontent.com/15709723/127752390-f6aa371f-31b5-4846-84b9-18dd4f662406.gif
146160
:width: 400
147161

148-
Try the `Python Quick Start Example <https://docs.openvino.ai/2024/notebooks/vision-monodepth-with-output.html>`__ to estimate depth in a scene using an OpenVINO monodepth model in a Jupyter Notebook inside your web browser.
162+
Try the `Python Quick Start Example <https://docs.openvino.ai/2024/notebooks/vision-monodepth-with-output.html>`__
163+
to estimate depth in a scene using an OpenVINO monodepth model in a Jupyter Notebook inside
164+
your web browser.
165+
149166

150167
Get started with Python
151168
+++++++++++++++++++++++
152169

153-
Visit the :doc:`Tutorials <../../../learn-openvino/interactive-tutorials-python>` page for more Jupyter Notebooks to get you started with OpenVINO, such as:
170+
Visit the :doc:`Tutorials <../../../learn-openvino/interactive-tutorials-python>` page for more
171+
Jupyter Notebooks to get you started with OpenVINO, such as:
154172

155173
* `OpenVINO Python API Tutorial <https://docs.openvino.ai/2024/notebooks/openvino-api-with-output.html>`__
156174
* `Basic image classification program with Hello Image Classification <https://docs.openvino.ai/2024/notebooks/hello-world-with-output.html>`__

docs/sphinx_setup/conf.py

+3-1
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,9 @@
5555
'.md': 'markdown',
5656
}
5757

58-
# html_baseurl = 'https://docs.openvino.ai/canonical/'
58+
59+
# html_baseurl = 'https://docs.openvino.ai/2024/'
60+
5961

6062
# -- Sitemap configuration ---------------------------------------------------
6163

0 commit comments

Comments
 (0)