IntenseWebs/openvino
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc script changes (#8568)

Browse Source 
* fix openvino-sphinx-theme

* add linkcheck target

* fix

* change version

* add doxygen-xfail.txt

* fix

* AA

* fix

* fix

* fix

* fix

* fix
This commit is contained in:
Nikolay Tyukaev
2021-11-13 00:17:59 +03:00
committed by GitHub
parent e2a469a345
commit 400e0657cd
6 changed files with 179 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
docs/CMakeLists.txt
View File

@@ -219,6 +219,11 @@ function(build_docs)
WORKING_DIRECTORY ${RST_OUTPUT}
VERBATIM)
add_custom_target(linkcheck
COMMAND sphinx-build -b linkcheck ${RST_OUTPUT} ${SPHINX_OUTPUT}
WORKING_DIRECTORY ${RST_OUTPUT}
VERBATIM)
set_target_properties(doxygen_xml sphinx_docs
PROPERTIES FOLDER docs)

13
docs/_static/js/custom.js vendored
View File

@@ -2,6 +2,19 @@ var sw_anchors = {};
var urlSearchParams = new URLSearchParams(window.location.search);
var sw_timer;
/* Adobe Analytics */
var wapLocalCode = 'us-en';
var wapSection = 'openvinotoolkit';
(function () {
var host = (window.document.location.protocol == 'http:') ? "http://www.intel.com" : "https://www.intel.com";
var url = host + "/content/dam/www/global/wap/tms-loader.js"; //wap file url
var po = document.createElement('script');
po.type = 'text/javascript'; po.async = true; po.src = url;
var s = document.getElementsByTagName('head')[0];
s.appendChild(po);
})();
$(document).ready(function() {
init_col_sections();
init_switchers();

2
docs/conf.py
View File

@@ -81,7 +81,7 @@ html_theme_options = {
}
html_context = {
'current_version': 'Latest',
'current_version': '2021.4',
'current_language': 'English',
'languages': (('English', '/latest'), ('Chinese', '/cn/latest')),
'versions': (('Latest', '/latest'), ('2021.4', '/2021.4'),

158
docs/doxygen-xfail.txt Normal file
View File

@@ -0,0 +1,158 @@
inference-engine/include/ie_api.h
inference-engine/ie_bridges/c/include/c_api/ie_c_api.h
doxygen_errors
ngraph/core/include/ngraph/descriptor/tensor.hpp
ngraph/core/include/ngraph/node.hpp
ngraph/core/include/ngraph/op/constant.hpp
ngraph/core/include/ngraph/op/util/fused_op.hpp
ngraph/core/include/ngraph/opsets/opset1.hpp
ngraph/core/include/ngraph/opsets/opset2.hpp
ngraph/core/include/ngraph/opsets/opset3.hpp
ngraph/core/include/ngraph/opsets/opset4.hpp
ngraph/core/include/ngraph/opsets/opset5.hpp
ngraph/core/include/ngraph/opsets/opset6.hpp
ngraph/core/include/ngraph/opsets/opset7.hpp
ngraph/core/include/ngraph/pass/low_latency.hpp
ngraph/core/include/ngraph/pass/pass.hpp
ngraph/core/include/ngraph/attribute_adapter.hpp
inference-engine/include/ie_parallel.hpp
openvino/itt/include/openvino/itt.hpp
inference-engine/src/transformations/include/ngraph_ops/type_relaxed.hpp
ngraph/core/include/ngraph/variant.hpp
openvino/docs/IE_DG/supported_plugins/GNA.md
inference-engine/src/plugin_api/ie_system_conf.h
ngraph/core/include/ngraph/check.hpp
openvino/docs/documentation.md
openvino/docs/gapi/face_beautification.md
openvino/docs/gapi/gapi_face_analytics_pipeline.md
openvino/docs/get_started/get_started_demos.md
openvino/docs/get_started/get_started_dl_workbench.md
openvino/docs/get_started/get_started_linux.md
openvino/docs/get_started/get_started_macos.md
openvino/docs/get_started/get_started_raspbian.md
openvino/docs/get_started/get_started_windows.md
openvino/docs/HOWTO/Custom_Layers_Guide.md
openvino/docs/IE_DG/inference_engine_intro.md
openvino/docs/IE_DG/Int8Inference.md
openvino/docs/IE_DG/Intro_to_Performance.md
openvino/docs/IE_DG/Model_Downloader.md
openvino/docs/IE_DG/protecting_model_guide.md
openvino/docs/IE_DG/Samples_Overview.md
openvino/docs/IE_DG/ShapeInference.md
openvino/docs/IE_DG/Tools_Overview.md
openvino/docs/IE_PLUGIN_DG/PluginTesting.md
openvino/docs/index.md
openvino/docs/install_guides/deployment-manager-tool.md
openvino/docs/install_guides/installing-openvino-apt.md
openvino/docs/install_guides/installing-openvino-docker-linux.md
openvino/docs/install_guides/installing-openvino-docker-windows.md
openvino/docs/install_guides/installing-openvino-images.md
openvino/docs/install_guides/installing-openvino-linux-ivad-vpu.md
openvino/docs/install_guides/installing-openvino-linux.md
openvino/docs/install_guides/installing-openvino-macos.md
openvino/docs/install_guides/installing-openvino-raspbian.md
openvino/docs/install_guides/installing-openvino-windows.md
openvino/docs/install_guides/installing-openvino-yum.md
openvino/docs/MO_DG/Deep_Learning_Model_Optimizer_DevGuide.md
openvino/docs/MO_DG/prepare_model/Additional_Optimizations.md
openvino/docs/MO_DG/prepare_model/convert_model/IR_suitable_for_INT8_inference.md
openvino/docs/MO_DG/prepare_model/convert_model/tf_specific/Convert_Object_Detection_API_Models.md
openvino/docs/MO_DG/prepare_model/convert_model/tf_specific/Convert_YOLO_From_Tensorflow.md
openvino/docs/MO_DG/prepare_model/customize_model_optimizer/Customize_Model_Optimizer.md
openvino/docs/MO_DG/prepare_model/Default_Model_Optimizer_Optimizations.md
openvino/docs/MO_DG/prepare_model/Getting_performance_numbers.md
openvino/docs/model_zoo.md
openvino/docs/optimization_guide/dldt_deployment_optimization_guide.md
openvino/docs/optimization_guide/dldt_deployment_optimization_guide_additional.md
openvino/docs/ovsa/ovsa_get_started.md
openvino/docs/resources/introduction.md
openvino/docs/security_guide/workbench.md
openvino/inference-engine/ie_bridges/c/docs/api_overview.md
openvino/inference-engine/ie_bridges/c/samples/hello_classification/README.md
openvino/inference-engine/ie_bridges/c/samples/hello_nv12_input_classification/README.md
openvino/inference-engine/ie_bridges/c/samples/object_detection_sample_ssd/README.md
openvino/inference-engine/ie_bridges/python/sample/classification_sample_async/README.md
openvino/inference-engine/ie_bridges/python/sample/hello_classification/README.md
openvino/inference-engine/ie_bridges/python/sample/hello_reshape_ssd/README.md
openvino/inference-engine/ie_bridges/python/sample/ngraph_function_creation_sample/README.md
openvino/inference-engine/ie_bridges/python/sample/object_detection_sample_ssd/README.md
openvino/inference-engine/ie_bridges/python/sample/speech_sample/README.md
openvino/inference-engine/ie_bridges/python/sample/style_transfer_sample/README.md
openvino/inference-engine/samples/benchmark_app/README.md
openvino/inference-engine/samples/classification_sample_async/README.md
openvino/inference-engine/samples/hello_classification/README.md
openvino/inference-engine/samples/hello_nv12_input_classification/README.md
openvino/inference-engine/samples/hello_reshape_ssd/README.md
openvino/inference-engine/samples/object_detection_sample_ssd/README.md
openvino/inference-engine/samples/speech_sample/README.md
openvino/inference-engine/samples/style_transfer_sample/README.md
openvino/inference-engine/tools/benchmark_tool/README.md
inference-engine/src/plugin_api/exec_graph_info.hpp
inference-engine/src/plugin_api/cpp_interfaces/interface/ie_iplugin_internal.hpp
inference-engine/src/plugin_api/cpp_interfaces/impl/ie_infer_async_request_thread_safe_default.hpp
inference-engine/src/plugin_api/cpp_interfaces/interface/ie_iinfer_request_internal.hpp
inference-engine/src/plugin_api/threading/ie_istreams_executor.hpp
inference-engine/include/gpu/gpu_context_api_ocl.hpp
ngraph/core/include/ngraph/validation_util.hpp
inference-engine/src/transformations/include/transformations/rt_info/primitives_priority_attribute.hpp
ngraph/core/include/ngraph/attribute_visitor.hpp
ngraph/core/include/ngraph/dimension.hpp
ngraph/core/include/ngraph/evaluator.hpp
ngraph/core/include/ngraph/file_util.hpp
ngraph/core/include/ngraph/op/util/attr_types.hpp
inference-engine/src/transformations/include/ngraph_ops/convolution_ie.hpp
ngraph/core/include/ngraph/op/util/rnn_cell_base.hpp
ngraph/core/include/ngraph/op/util/binary_elementwise_logical.hpp
ngraph/core/include/ngraph/op/util/embeddingbag_offsets_base.hpp
ngraph/core/include/ngraph/op/util/embeddingbag_packed_base.hpp
ngraph/core/include/ngraph/op/cum_sum.hpp
ngraph/core/include/ngraph/op/fake_quantize.hpp
ngraph/core/include/ngraph/op/lrn.hpp
ngraph/core/include/ngraph/op/result.hpp
ngraph/core/include/ngraph/op/deformable_psroi_pooling.hpp
ngraph/core/include/ngraph/op/non_max_suppression.hpp
ngraph/core/include/ngraph/op/embedding_segments_sum.hpp
ngraph/core/include/ngraph/op/embeddingbag_offsets_sum.hpp
ngraph/core/include/ngraph/op/embeddingbag_packedsum.hpp
ngraph/core/include/ngraph/op/extractimagepatches.hpp
ngraph/core/include/ngraph/op/gru_cell.hpp
ngraph/core/include/ngraph/op/ctc_loss.hpp
ngraph/core/include/ngraph/op/hswish.hpp
ngraph/core/include/ngraph/op/mish.hpp
ngraph/core/include/ngraph/op/softplus.hpp
ngraph/core/include/ngraph/op/swish.hpp
ngraph/core/include/ngraph/op/hsigmoid.hpp
ngraph/core/include/ngraph/op/assign.hpp
ngraph/core/include/ngraph/op/read_value.hpp
ngraph/core/include/ngraph/pattern/matcher.hpp
ngraph/core/include/ngraph/pattern/op/any_output.hpp
ngraph/core/include/ngraph/op/interpolate.hpp
ngraph/core/include/ngraph/op/util/binary_elementwise_arithmetic.hpp
gst/docs/index.md
open_model_zoo/models/public/i3d-rgb-tf/README.md
open_model_zoo/models/public/index.md
open_model_zoo/tools/accuracy_checker/accuracy_checker/annotation_converters/README.md
open_model_zoo/tools/accuracy_checker/README.md
workbench/configs/README.md
workbench/docs/CLI.md
workbench/docs/FrequentlyAskedQuestions.md
workbench/docs/InstallationGuide.md
workbench/README.md
workbench/README_dev.md
pot/configs/README.md
pot/docs/CLI.md
pot/docs/FrequentlyAskedQuestions.md
pot/docs/InstallationGuide.md
pot/README.md
pot/README_dev.md
workbench/docs/Workbench_DG/Set_Accuracy_Config.md
workbench/docs/Workbench_DG/Int-8_Quantization.md
workbench/docs/Workbench_DG/Remote_Profiling.md
workbench/docs/Workbench_DG/Run_Baseline_Inference.md
workbench/docs/Workbench_DG/Run_Range_of_Inferences.md
workbench/docs/Workbench_DG/Run_Single_Inference.md
workbench/docs/Workbench_DG/Select_Models.md
workbench/docs/Workbench_DG/Visualize_Accuracy.md
ngraph/core/include/ngraph/type.hpp
openvino/docs/IE_DG/network_state_intro.md
workbench/docs/Workbench_DG/Compare_Performance_between_Two_Versions_of_Models.md

2
docs/nbdoc/utils.py
View File

@@ -55,7 +55,7 @@ def load_secret(path: str = "../.secret") -> str:
"""
with open(path, "r+") as file:
return file.readline()
return file.readline().strip()
def process_notebook_name(notebook_name: str) -> str:

2
docs/openvino_sphinx_theme/MANIFEST.in
View File

@@ -1,3 +1,3 @@
include openvino_sphinx_theme/theme.conf
recursive-include openvino_sphinx_theme *.html
recursive-include openvino_sphinx_theme *.html *.rst
recursive-include openvino_sphinx_theme/static *.js *.png *.css *.svg