diff --git a/docs/Documentation/media_processing_cv_libraries.md b/docs/Documentation/media_processing_cv_libraries.md new file mode 100644 index 00000000000..0ca3ad22408 --- /dev/null +++ b/docs/Documentation/media_processing_cv_libraries.md @@ -0,0 +1,15 @@ +# Media Processing and CV Libraries {#media_processing_cv_libraries} + +@sphinxdirective + +.. toctree:: + :maxdepth: 1 + + Intel® Deep Learning Streamer + openvino_docs_gapi_gapi_intro + OpenCV Developer Guide + OpenCL™ Developer Guide + OneVPL Developer Guide + +@endsphinxdirective + diff --git a/docs/Documentation/openvino_ecosystem.md b/docs/Documentation/openvino_ecosystem.md index 76210c692f5..62eb03c3419 100644 --- a/docs/Documentation/openvino_ecosystem.md +++ b/docs/Documentation/openvino_ecosystem.md @@ -1,5 +1,21 @@ # OpenVINO™ Ecosystem Overview {#openvino_ecosystem} +@sphinxdirective + +.. toctree:: + :maxdepth: 1 + :hidden: + + ovms_what_is_openvino_model_server + ovsa_get_started + ovtf_integration + ote_documentation + workbench_docs_Workbench_DG_Introduction + + +@endsphinxdirective + + OpenVINO™ is not just one tool. It is an expansive ecosystem of utilities, providing a comprehensive workflow for deep learning solution development. Learn more about each of them to reach the full potential of OpenVINO™ Toolkit. diff --git a/docs/Extensibility_UG/Intro.md b/docs/Extensibility_UG/Intro.md index 34031581aa5..1339e4794ba 100644 --- a/docs/Extensibility_UG/Intro.md +++ b/docs/Extensibility_UG/Intro.md @@ -11,6 +11,13 @@ openvino_docs_Extensibility_UG_GPU openvino_docs_Extensibility_UG_VPU_Kernel openvino_docs_MO_DG_prepare_model_customize_model_optimizer_Customize_Model_Optimizer + +.. toctree:: + :maxdepth: 1 + :hidden: + + openvino_docs_transformations + OpenVINO Plugin Developer Guide @endsphinxdirective diff --git a/docs/_static/css/custom.css b/docs/_static/css/custom.css index 8b5c2e8b6a0..59811a21311 100644 --- a/docs/_static/css/custom.css +++ b/docs/_static/css/custom.css @@ -31,11 +31,18 @@ ul#navbar-main-elements > li:hover { /* first level items in the side menu */ #bd-docs-nav > div > ul > li > a { color: #0068B5; + padding-bottom: 0; } -/* second level items left padding */ +/* second level items */ #bd-docs-nav > div > ul > li > ul { padding-left: 0.5rem; } +#bd-docs-nav div ul li ul li a { + padding-top: 0; + /*padding-bottom: 0; */ +} + + /* footer links */ /* =================================================== */ diff --git a/docs/conf.py b/docs/conf.py index 0d341d00aa7..08e52a9224c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -78,10 +78,12 @@ html_theme = "openvino_sphinx_theme" html_theme_path = ['_themes'] html_theme_options = { - "navigation_depth": 5, + "navigation_depth": 6, + "show_nav_level": 2, "use_edit_page_button": True, "github_url": "https://github.com/openvinotoolkit/openvino", "footer_items": ["footer_info"], + "show_prev_next": False, } html_context = { diff --git a/docs/documentation.md b/docs/documentation.md index 5481d5f08bb..722ebb532bf 100644 --- a/docs/documentation.md +++ b/docs/documentation.md @@ -4,10 +4,13 @@ .. toctree:: :maxdepth: 1 - :caption: API 2.0 :hidden: openvino_2_0_transition_guide + Tool Ecosystem + OpenVINO Extensibility + Media Processing and CV Libraries + OpenVINO™ Security .. toctree:: @@ -20,6 +23,7 @@ openvino_docs_MO_DG_Deep_Learning_Model_Optimizer_DevGuide omz_tools_downloader + .. toctree:: :maxdepth: 1 :caption: Running Inference @@ -49,52 +53,7 @@ openvino_docs_deployment_guide_introduction openvino_deployment_guide - - - -.. toctree:: - :maxdepth: 1 - :hidden: - :caption: THE Ecosystem - - openvino_ecosystem - ovms_what_is_openvino_model_server - ovsa_get_started - ovtf_integration - ote_documentation - workbench_docs_Workbench_DG_Introduction - - -.. toctree:: - :maxdepth: 1 - :caption: OpenVINO Extensibility - :hidden: - - openvino_docs_Extensibility_UG_Intro - openvino_docs_transformations - OpenVINO Plugin Developer Guide -.. toctree:: - :maxdepth: 1 - :hidden: - :caption: Use OpenVINO™ Toolkit Securely - - openvino_docs_security_guide_introduction - openvino_docs_security_guide_workbench - openvino_docs_OV_UG_protecting_model_guide - ovsa_get_started - -.. toctree:: - :maxdepth: 1 - :hidden: - :caption: Media Processing and Computer Vision Libraries - - Intel® Deep Learning Streamer - openvino_docs_gapi_gapi_intro - OpenCV Developer Guide - OpenCL™ Developer Guide - OneVPL Developer Guide - @endsphinxdirective This section provides reference documents that guide you through the OpenVINO toolkit workflow, from obtaining models, optimizing them, to deploying them in your own deep learning applications. diff --git a/docs/get_started.md b/docs/get_started.md index c6027c5f2ee..1ebd92a7931 100644 --- a/docs/get_started.md +++ b/docs/get_started.md @@ -5,22 +5,12 @@ .. toctree:: :maxdepth: 1 :hidden: - :caption: Install & Config Installing OpenVINO Additional Configurations Uninstalling Troubleshooting -.. toctree:: - :maxdepth: 1 - :hidden: - :caption: Get Started Guides - - Interactive Tutorials (Python) - Samples - - @endsphinxdirective @sphinxdirective diff --git a/docs/home.rst b/docs/home.rst index d25f9583203..ba61d17e857 100644 --- a/docs/home.rst +++ b/docs/home.rst @@ -116,10 +116,12 @@ OpenVINO™ Documentation .. toctree:: :maxdepth: 2 :hidden: - - get_started - documentation - tutorials - api/api_reference - model_zoo - resources + + GET STARTED + LEARN OPENVINO + DOCUMENTATION + API REFERENCE + MODEL ZOO + RESOURCES + RELEASE NOTES + diff --git a/docs/learn_openvino.md b/docs/learn_openvino.md new file mode 100644 index 00000000000..2014d98e7d6 --- /dev/null +++ b/docs/learn_openvino.md @@ -0,0 +1,17 @@ +# Learn OpenVINO {#learn_openvino} + +@sphinxdirective + +.. toctree:: + :maxdepth: 1 + :hidden: + + Interactive Tutorials (Python) + Sample Applications (Python & C++) + +@endsphinxdirective + +This section will help you get a hands-on experience with OpenVINO even if you are just starting +to learn what OpenVINO is and how it works. It includes various types of learning materials, +accommodating different learning needs, which means you should find it useful if you are a beginning, +as well as an experienced user. \ No newline at end of file diff --git a/docs/resources/openvino_ir.md b/docs/resources/openvino_ir.md new file mode 100644 index 00000000000..f0a925e10eb --- /dev/null +++ b/docs/resources/openvino_ir.md @@ -0,0 +1,23 @@ +# OpenVINO IR format {#openvino_ir} + + +@sphinxdirective + +.. toctree:: + :maxdepth: 1 + :hidden: + + openvino_docs_MO_DG_IR_and_opsets + openvino_docs_ops_opset + openvino_docs_ops_broadcast_rules + openvino_docs_operations_specifications + openvino_docs_MO_DG_prepare_model_convert_model_IR_suitable_for_INT8_inference + +@endsphinxdirective + + +OpenVINO IR (Intermediate Representation) is the proprietary model format of OpenVINO. +In this section you will find detailed information on its operations and application +in OpenVINO. + + diff --git a/docs/resources/resources.md b/docs/resources/resources.md index 1997f466a20..0257136c1ab 100644 --- a/docs/resources/resources.md +++ b/docs/resources/resources.md @@ -6,52 +6,43 @@ .. toctree:: :maxdepth: 1 :hidden: - :caption: Additional Resources - Release Notes + openvino_docs_performance_benchmarks + openvino_ir + +.. toctree:: + :maxdepth: 1 + :hidden: + openvino_docs_OV_UG_supported_plugins_Supported_Devices openvino_supported_models openvino_docs_MO_DG_prepare_model_Supported_Frameworks_Layers + +.. toctree:: + :maxdepth: 1 + :hidden: + openvino_docs_OV_Glossary openvino_docs_Legal_Information openvino_docs_telemetry_information - - -.. toctree:: - :maxdepth: 1 - :caption: Intermediate Representation and Operations Sets - :hidden: - - openvino_docs_MO_DG_IR_and_opsets - openvino_docs_ops_opset - openvino_docs_ops_broadcast_rules - openvino_docs_operations_specifications - openvino_docs_MO_DG_prepare_model_convert_model_IR_suitable_for_INT8_inference - - -.. toctree:: - :maxdepth: 1 - :hidden: - :caption: Case Studies - Case Studies + @endsphinxdirective -This section includes a variety of reference information in three broad categories. +This section includes a variety of reference information focusing mostly on describing OpenVINO +and its proprietary model format, OpenVINO IR. -### Additional Resources -[Release Notes](https://software.intel.com/content/www/us/en/develop/articles/openvino-relnotes.html) contains change logs and notes for each OpenVINO release. [Supported Devices](../OV_Runtime_UG/supported_plugins/Supported_Devices.md) is compatibility information about supported hardware accelerators. [Legal Information](../Legal_Information.md) has trademark information and other legal statements. -### Intermediate Representation and Operations Sets [Available Operation Sets](../ops/opset.md) is a list of supported operations and explanation of supported capabilities. [Broadcast Rules for Elementwise Operations](../ops/broadcast_rules.md) explains the rules used for to support an arbitrary number of dimensions in neural nets. -### Case Studies Links to [articles](https://www.intel.com/openvino-success-stories) about real-world examples of OpenVINO™ usage. + +[Release Notes](https://software.intel.com/content/www/us/en/develop/articles/openvino-relnotes.html) contains change logs and notes for each OpenVINO release. diff --git a/docs/security_guide/introduction.md b/docs/security_guide/introduction.md index 607a99bdada..b6dbae97d83 100644 --- a/docs/security_guide/introduction.md +++ b/docs/security_guide/introduction.md @@ -1,4 +1,17 @@ -# Introduction to OpenVINO™ Security {#openvino_docs_security_guide_introduction} +# OpenVINO™ Security {#openvino_docs_security_guide_introduction} + +@sphinxdirective + +.. toctree:: + :maxdepth: 1 + :hidden: + + openvino_docs_security_guide_workbench + openvino_docs_OV_UG_protecting_model_guide + ovsa_get_started + +@endsphinxdirective + Deploying deep learning models for OpenVINO™ may raise security and privacy issues. Trained models are often valuable intellectual property and you may choose to protect them with encryption or other security tools.