Fixing toctree directives

sgolebiewski-intel · Aug 6, 2024 · 7c956ea · 7c956ea
1 parent bde76f8
commit 7c956ea
Show file tree

Hide file tree

Showing 4 changed files with 354 additions and 375 deletions.
diff --git a/demos/README.md b/demos/README.md
@@ -1,77 +1,73 @@
 # Open Model Zoo Demos
 
-<!--
-@sphinxdirective
-
-.. toctree::
-   :maxdepth: 1
-   :hidden:
-
-   omz_demos_human_pose_estimation_3d_demo_python
-   omz_demos_3d_segmentation_demo_python
-   omz_demos_action_recognition_demo_python
-   omz_demos_background_subtraction_demo_cpp_gapi
-   omz_demos_background_subtraction_demo_python
-   omz_demos_bert_named_entity_recognition_demo_python
-   omz_demos_bert_question_answering_embedding_demo_python
-   omz_demos_bert_question_answering_demo_python
-   omz_demos_classification_benchmark_demo_cpp
-   omz_demos_classification_benchmark_demo_cpp_gapi
-   omz_demos_classification_demo_python
-   omz_demos_colorization_demo_python
-   omz_demos_crossroad_camera_demo_cpp
-   omz_demos_face_recognition_demo_python
-   omz_demos_formula_recognition_demo_python
-   omz_demos_gaze_estimation_demo_cpp_gapi
-   omz_demos_interactive_face_detection_demo_cpp_gapi
-   omz_demos_gaze_estimation_demo_cpp
-   omz_demos_gesture_recognition_demo_cpp_gapi
-   omz_demos_gesture_recognition_demo_python
-   omz_demos_gpt2_text_prediction_demo_python
-   omz_demos_handwritten_text_recognition_demo_python
-   omz_demos_human_pose_estimation_demo_cpp
-   omz_demos_human_pose_estimation_demo_python
-   omz_demos_image_inpainting_demo_python
-   omz_demos_image_processing_demo_cpp
-   omz_demos_image_retrieval_demo_python
-   omz_demos_segmentation_demo_cpp
-   omz_demos_segmentation_demo_python
-   omz_demos_image_translation_demo_python
-   omz_demos_instance_segmentation_demo_python
-   omz_demos_interactive_face_detection_demo_cpp
-   omz_demos_machine_translation_demo_python
-   omz_demos_monodepth_demo_python
-   omz_demos_mri_reconstruction_demo_cpp
-   omz_demos_mri_reconstruction_demo_python
-   omz_demos_multi_camera_multi_target_tracking_demo_python
-   omz_demos_multi_channel_face_detection_demo_cpp
-   omz_demos_multi_channel_human_pose_estimation_demo_cpp
-   omz_demos_multi_channel_object_detection_demo_yolov3_cpp
-   omz_demos_noise_suppression_demo_cpp
-   omz_demos_noise_suppression_demo_python
-   omz_demos_object_detection_demo_cpp
-   omz_demos_object_detection_demo_python
-   omz_demos_pedestrian_tracker_demo_cpp
-   omz_demos_place_recognition_demo_python
-   omz_demos_security_barrier_camera_demo_cpp
-   omz_demos_single_human_pose_estimation_demo_python
-   omz_demos_smartlab_demo_python
-   omz_demos_smart_classroom_demo_cpp
-   omz_demos_smart_classroom_demo_cpp_gapi
-   omz_demos_social_distance_demo_cpp
-   omz_demos_sound_classification_demo_python
-   omz_demos_speech_recognition_deepspeech_demo_python
-   omz_demos_speech_recognition_quartznet_demo_python
-   omz_demos_speech_recognition_wav2vec_demo_python
-   omz_demos_mask_rcnn_demo_cpp
-   omz_demos_text_detection_demo_cpp
-   omz_demos_text_spotting_demo_python
-   omz_demos_text_to_speech_demo_python
-   omz_demos_time_series_forecasting_demo_python
-   omz_demos_whiteboard_inpainting_demo_python
-
-@endsphinxdirective
--->
+```{toctree}
+:maxdepth: 1
+:hidden:
+
+   3D Human Pose Estimation Python Demo <omz_demos_human_pose_estimation_3d_demo_python>
+   3D Segmentation Python Demo <omz_demos_3d_segmentation_demo_python>
+   Action Recognition Python Demo <omz_demos_action_recognition_demo_python>
+   G-API Background Subtraction Demo <omz_demos_background_subtraction_demo_cpp_gapi>
+   Background subtraction Python Demo <omz_demos_background_subtraction_demo_python>
+   BERT Named Entity Recognition Python Demo <omz_demos_bert_named_entity_recognition_demo_python>
+   BERT Question Answering Embedding Python Demo <omz_demos_bert_question_answering_embedding_demo_python>
+   BERT Question Answering Python Demo <omz_demos_bert_question_answering_demo_python>
+   Classification Benchmark C++ Demo <omz_demos_classification_benchmark_demo_cpp>
+   Classification Benchmark C++ G-API Demo <omz_demos_classification_benchmark_demo_cpp_gapi>
+   Classification Python Demo <omz_demos_classification_demo_python>
+   Colorization Demo <omz_demos_colorization_demo_python>
+   Crossroad Camera C++ Demo <omz_demos_crossroad_camera_demo_cpp>
+   Face Recognition Python Demo <omz_demos_face_recognition_demo_python>
+   Formula Recognition Python Demo <omz_demos_formula_recognition_demo_python>
+   G-API Gaze Estimation Demo <omz_demos_gaze_estimation_demo_cpp_gapi>
+   G-API Interactive Face Detection Demo <omz_demos_interactive_face_detection_demo_cpp_gapi>
+   Gaze Estimation Demo <omz_demos_gaze_estimation_demo_cpp>
+   G-API Gesture Recognition Demo <omz_demos_gesture_recognition_demo_cpp_gapi>
+   Gesture Recognition Python Demo <omz_demos_gesture_recognition_demo_python>
+   GPT-2 Text Prediction Python Demo <omz_demos_gpt2_text_prediction_demo_python>
+   Handwritten Text Recognition Demo <omz_demos_handwritten_text_recognition_demo_python>
+   Human Pose Estimation C++ Demo <omz_demos_human_pose_estimation_demo_cpp>
+   Human Pose Estimation Python Demo <omz_demos_human_pose_estimation_demo_python>
+   Image Inpainting Python Demo <omz_demos_image_inpainting_demo_python>
+   Image Processing C++ Demo <omz_demos_image_processing_demo_cpp>
+   Image Retrieval Python Demo <omz_demos_image_retrieval_demo_python>
+   Image Segmentation C++ Demo <omz_demos_segmentation_demo_cpp>
+   Image Segmentation Python Demo <omz_demos_segmentation_demo_python>
+   Image Translation Demo <omz_demos_image_translation_demo_python>
+   Instance Segmentation Python Demo <omz_demos_instance_segmentation_demo_python>
+   Interactive Face Detection C++ Demo <omz_demos_interactive_face_detection_demo_cpp>
+   Machine Translation Python Demo <omz_demos_machine_translation_demo_python>
+   MonoDepth Python Demo <omz_demos_monodepth_demo_python>
+   MRI Reconstruction C++ Demo <omz_demos_mri_reconstruction_demo_cpp>
+   MRI Reconstruction Python Demo <omz_demos_mri_reconstruction_demo_python>
+   Multi Camera Multi Target Python Demo <omz_demos_multi_camera_multi_target_tracking_demo_python>
+   Multi-Channel Face Detection C++ Demo <omz_demos_multi_channel_face_detection_demo_cpp>
+   Multi-Channel Human Pose Estimation C++ Demo <omz_demos_multi_channel_human_pose_estimation_demo_cpp>
+   Multi-Channel Object Detection Yolov3 C++ Demo <omz_demos_multi_channel_object_detection_demo_yolov3_cpp>
+   Noise Suppression C++ Demo <omz_demos_noise_suppression_demo_cpp>
+   Noise Suppression Python Demo <omz_demos_noise_suppression_demo_python>
+   Object Detection C++ Demo <omz_demos_object_detection_demo_cpp>
+   Object Detection Python Demo <omz_demos_object_detection_demo_python>
+   Pedestrian Tracker C++ Demo <omz_demos_pedestrian_tracker_demo_cpp>
+   Place Recognition Python Demo <omz_demos_place_recognition_demo_python>
+   Security Barrier Camera C++ Demo <omz_demos_security_barrier_camera_demo_cpp>
+   Single Human Pose Estimation Demo (top-down pipeline) <omz_demos_single_human_pose_estimation_demo_python>
+   Smartlab Python Demo <omz_demos_smartlab_demo_python>
+   Smart Classroom C++ Demo <omz_demos_smart_classroom_demo_cpp>
+   Smart Classroom C++ G-API Demo <omz_demos_smart_classroom_demo_cpp_gapi>
+   Social Distance C++ Demo <omz_demos_social_distance_demo_cpp>
+   Sound Classification Python Demo <omz_demos_sound_classification_demo_python>
+   Speech Recognition DeepSpeech Python Demo <omz_demos_speech_recognition_deepspeech_demo_python>
+   Speech Recognition QuartzNet Python Demo <omz_demos_speech_recognition_quartznet_demo_python>
+   Speech Recognition Wav2Vec Python Demo <omz_demos_speech_recognition_wav2vec_demo_python>
+   TensorFlow Object Detection Mask R-CNNs Segmentation C++ Demo <omz_demos_mask_rcnn_demo_cpp>
+   Text Detection C++ Demo <omz_demos_text_detection_demo_cpp>
+   Text Spotting Python Demo <omz_demos_text_spotting_demo_python>
+   Text-to-speech Python Demo <omz_demos_text_to_speech_demo_python>
+   Time Series Forecasting Python Demo <omz_demos_time_series_forecasting_demo_python>
+   Whiteboard Inpainting Python Demo <omz_demos_whiteboard_inpainting_demo_python>
+```
+
 
 Open Model Zoo demos are console applications that provide templates to help implement specific deep learning inference scenarios. These applications show how to preprocess and postrpocess data for model inference and organize processing pipelines. Some pipelines collect analysis data from several models being inferred simultaneously. For example, [detecting a person in a video stream along with detecting the person's physical attributes, such as age, gender, and emotional state](./interactive_face_detection_demo/cpp/README.md).