rework sphinx markdown directives (#2088)

Author: jmacekx

demos/README.md

@@ -1,39 +1,38 @@
 # Demos {#ovms_docs_demos}
 
-@sphinxdirective
+```{toctree}
+---
+maxdepth: 1
+hidden:
+---
 
-.. toctree::
-   :maxdepth: 1
-   :hidden:
-
-   ovms_demo_age_gender_guide
-   ovms_demo_horizontal_text_detection
-   ovms_demo_optical_character_recognition
-   ovms_demo_face_detection
-   ovms_demo_face_blur_pipeline
-   ovms_demo_capi_inference_demo
-   ovms_demo_single_face_analysis_pipeline
-   ovms_demo_multi_faces_analysis_pipeline
-   ovms_docs_demo_ensemble
-   ovms_docs_demo_mediapipe_image_classification
-   ovms_docs_demo_mediapipe_multi_model
-   ovms_docs_demo_mediapipe_object_detection
-   ovms_docs_demo_mediapipe_holistic
-   ovms_docs_image_classification
-   ovms_demo_using_onnx_model
-   ovms_demo_tf_classification
-   ovms_demo_person_vehicle_bike_detection
-   ovms_demo_vehicle_analysis_pipeline
-   ovms_demo_real_time_stream_analysis
-   ovms_demo_bert
-   ovms_demo_gptj_causal_lm
-   ovms_demo_llama_2_chat
-   ovms_demo_stable_diffusion
-   ovms_demo_universal-sentence-encoder
-   ovms_demo_speech_recognition
-   ovms_demo_benchmark_client
-
-@endsphinxdirective
+ovms_demo_age_gender_guide
+ovms_demo_horizontal_text_detection
+ovms_demo_optical_character_recognition
+ovms_demo_face_detection
+ovms_demo_face_blur_pipeline
+ovms_demo_capi_inference_demo
+ovms_demo_single_face_analysis_pipeline
+ovms_demo_multi_faces_analysis_pipeline
+ovms_docs_demo_ensemble
+ovms_docs_demo_mediapipe_image_classification
+ovms_docs_demo_mediapipe_multi_model
+ovms_docs_demo_mediapipe_object_detection
+ovms_docs_demo_mediapipe_holistic
+ovms_docs_image_classification
+ovms_demo_using_onnx_model
+ovms_demo_tf_classification
+ovms_demo_person_vehicle_bike_detection
+ovms_demo_vehicle_analysis_pipeline
+ovms_demo_real_time_stream_analysis
+ovms_demo_bert
+ovms_demo_gptj_causal_lm
+ovms_demo_llama_2_chat
+ovms_demo_stable_diffusion
+ovms_demo_universal-sentence-encoder
+ovms_demo_speech_recognition
+ovms_demo_benchmark_client
+```
 
 OpenVINO Model Server demos have been created to showcase the usage of the model server as well as demonstrate it’s capabilities. Check out the list below to see complete step-by-step examples of using OpenVINO Model Server with real world use cases:
 

demos/benchmark/README.md

@@ -1,15 +1,14 @@
 # Benchmark Client {#ovms_demo_benchmark_client}
 
-@sphinxdirective
+```{toctree}
+---
+maxdepth: 1
+hidden:
+---
 
-.. toctree::
-   :maxdepth: 1
-   :hidden:
-
-   ovms_demo_benchmark_app
-   ovms_demo_benchmark_app_cpp
-
-@endsphinxdirective
+ovms_demo_benchmark_app
+ovms_demo_benchmark_app_cpp
+```
 
 ## Python
 | Demo | Description |

demos/image_classification/README.md

@@ -1,16 +1,15 @@
 # Image Classification Demos {#ovms_docs_image_classification}
 
-@sphinxdirective
+```{toctree}
+---
+maxdepth: 1
+hidden:
+---
 
-.. toctree::
-   :maxdepth: 1
-   :hidden:
-
-   ovms_demo_image_classification
-   ovms_demo_image_classification_cpp
-   ovms_demo_image_classification_go
-
-@endsphinxdirective
+ovms_demo_image_classification
+ovms_demo_image_classification_cpp
+ovms_demo_image_classification_go
+```
 
 ## Python 
 | Demo | Description |

docs/accelerators.md

@@ -26,35 +26,26 @@ Before using GPU as OpenVINO Model Server target device, you need to:
 
 Running inference on GPU requires the model server process security context account to have correct permissions. It must belong to the render group identified by the command:
 
-@sphinxdirective
-.. code-block:: sh
-
-    stat -c "group_name=%G group_id=%g" /dev/dri/render*
-
-@endsphinxdirective
+```bash
+stat -c "group_name=%G group_id=%g" /dev/dri/render*
+```
 
 The default account in the docker image is preconfigured. If you change the security context, use the following command to start the model server container:
 
-@sphinxdirective
-.. code-block:: sh
-
-    docker run --rm -it  --device=/dev/dri --group-add=$(stat -c "%g" /dev/dri/render* | head -n 1) -u $(id -u):$(id -g) \
-    -v ${PWD}/models/public/resnet-50-tf:/opt/model -p 9001:9001 openvino/model_server:latest-gpu \
-    --model_path /opt/model --model_name resnet --port 9001 --target_device GPU
-
-@endsphinxdirective
+```bash
+docker run --rm -it  --device=/dev/dri --group-add=$(stat -c "%g" /dev/dri/render* | head -n 1) -u $(id -u):$(id -g) \
+-v ${PWD}/models/public/resnet-50-tf:/opt/model -p 9001:9001 openvino/model_server:latest-gpu \
+--model_path /opt/model --model_name resnet --port 9001 --target_device GPU
+```
 
 GPU device can be used also on Windows hosts with Windows Subsystem for Linux 2 (WSL2). In such scenario, there are needed extra docker parameters. See the command below.
 Use device `/dev/dxg` instead of `/dev/dri` and mount the volume `/usr/lib/wsl`:
 
-@sphinxdirective
-.. code-block:: sh
-
-    docker run --rm -it  --device=/dev/dxg --volume /usr/lib/wsl:/usr/lib/wsl -u $(id -u):$(id -g) \
-    -v ${PWD}/models/public/resnet-50-tf:/opt/model -p 9001:9001 openvino/model_server:latest-gpu \
-    --model_path /opt/model --model_name resnet --port 9001 --target_device GPU
-
-@endsphinxdirective
+```bash
+docker run --rm -it  --device=/dev/dxg --volume /usr/lib/wsl:/usr/lib/wsl -u $(id -u):$(id -g) \
+-v ${PWD}/models/public/resnet-50-tf:/opt/model -p 9001:9001 openvino/model_server:latest-gpu \
+--model_path /opt/model --model_name resnet --port 9001 --target_device GPU
+```
 
 > **NOTE**:
 > The public docker image includes the OpenCL drivers for GPU in version 22.28 (RedHat) and 22.35 (Ubuntu).
@@ -136,15 +127,12 @@ Make sure you have passed the devices and access to the devices you want to use
 
 Below is an example of the command with AUTO Plugin as target device. It includes extra docker parameters to enable GPU (/dev/dri) , beside CPU.
 
-@sphinxdirective
-.. code-block:: sh
-
-    docker run --rm -d --device=/dev/dri --group-add=$(stat -c "%g" /dev/dri/render* | head -n 1) \
-    -u $(id -u):$(id -g) -v ${PWD}/models/public/resnet-50-tf:/opt/model -p 9001:9001 openvino/model_server:latest-gpu \
-    --model_path /opt/model --model_name resnet --port 9001 \
-    --target_device AUTO
-
-@endsphinxdirective
+```bash
+docker run --rm -d --device=/dev/dri --group-add=$(stat -c "%g" /dev/dri/render* | head -n 1) \
+-u $(id -u):$(id -g) -v ${PWD}/models/public/resnet-50-tf:/opt/model -p 9001:9001 openvino/model_server:latest-gpu \
+--model_path /opt/model --model_name resnet --port 9001 \
+--target_device AUTO
+```
 
 The `Auto Device` plugin can also use the [PERFORMANCE_HINT](performance_tuning.md) plugin config property that enables you to specify a performance mode for the plugin.
 
@@ -154,29 +142,23 @@ To enable Performance Hints for your application, use the following command:
 
 LATENCY
 
-@sphinxdirective
-.. code-block:: sh
-
-    docker run --rm -d --device=/dev/dri --group-add=$(stat -c "%g" /dev/dri/render* | head -n 1) -u $(id -u):$(id -g) \
-    -v ${PWD}/models/public/resnet-50-tf:/opt/model -p 9001:9001 openvino/model_server:latest-gpu \
-    --model_path /opt/model --model_name resnet --port 9001 \
-    --plugin_config '{"PERFORMANCE_HINT": "LATENCY"}' \
-    --target_device AUTO
-
-@endsphinxdirective
+```bash
+docker run --rm -d --device=/dev/dri --group-add=$(stat -c "%g" /dev/dri/render* | head -n 1) -u $(id -u):$(id -g) \
+-v ${PWD}/models/public/resnet-50-tf:/opt/model -p 9001:9001 openvino/model_server:latest-gpu \
+--model_path /opt/model --model_name resnet --port 9001 \
+--plugin_config '{"PERFORMANCE_HINT": "LATENCY"}' \
+--target_device AUTO
+```
 
 THROUGHPUT
 
-@sphinxdirective
-.. code-block:: sh
-
-    docker run --rm -d --device=/dev/dri --group-add=$(stat -c "%g" /dev/dri/render* | head -n 1) -u $(id -u):$(id -g) \
-    -v ${PWD}/models/public/resnet-50-tf:/opt/model -p 9001:9001 openvino/model_server:latest-gpu \
-    --model_path /opt/model --model_name resnet --port 9001 \
-    --plugin_config '{"PERFORMANCE_HINT": "THROUGHPUT"}' \
-    --target_device AUTO
-
-@endsphinxdirective
+```bash
+docker run --rm -d --device=/dev/dri --group-add=$(stat -c "%g" /dev/dri/render* | head -n 1) -u $(id -u):$(id -g) \
+-v ${PWD}/models/public/resnet-50-tf:/opt/model -p 9001:9001 openvino/model_server:latest-gpu \
+--model_path /opt/model --model_name resnet --port 9001 \
+--plugin_config '{"PERFORMANCE_HINT": "THROUGHPUT"}' \
+--target_device AUTO
+```
 
 > **NOTE**: currently, AUTO plugin cannot be used with `--shape auto` parameter while GPU device is enabled.
 
@@ -186,22 +168,22 @@ OpenVINO Model Server can be used also with NVIDIA GPU cards by using NVIDIA plu
 The docker image of OpenVINO Model Server including support for NVIDIA can be built from sources
 
 ```bash
-   git clone https://github.com/openvinotoolkit/model_server.git
-   cd model_server
-   make docker_build NVIDIA=1 OV_USE_BINARY=0
-   cd ..
+git clone https://github.com/openvinotoolkit/model_server.git
+cd model_server
+make docker_build NVIDIA=1 OV_USE_BINARY=0
+cd ..
 ```
 Check also [building from sources](https://github.com/openvinotoolkit/model_server/blob/main/docs/build_from_source.md).
 
 Example command to run container with NVIDIA support:
 
 ```bash
-   docker run -it --gpus all -p 9000:9000 -v ${PWD}/models/public/resnet-50-tf:/opt/model openvino/model_server:latest-cuda --model_path /opt/model --model_name resnet --port 9000 --target_device NVIDIA
+docker run -it --gpus all -p 9000:9000 -v ${PWD}/models/public/resnet-50-tf:/opt/model openvino/model_server:latest-cuda --model_path /opt/model --model_name resnet --port 9000 --target_device NVIDIA
 ```
 
 For models with layers not supported on NVIDIA plugin, you can use a virtual plugin `HETERO` which can use multiple devices listed after the colon:
 ```bash
-   docker run -it --gpus all -p 9000:9000 -v ${PWD}/models/public/resnet-50-tf:/opt/model openvino/model_server:latest-cuda --model_path /opt/model --model_name resnet --port 9000 --target_device HETERO:NVIDIA,CPU
+docker run -it --gpus all -p 9000:9000 -v ${PWD}/models/public/resnet-50-tf:/opt/model openvino/model_server:latest-cuda --model_path /opt/model --model_name resnet --port 9000 --target_device HETERO:NVIDIA,CPU
 ```
 
 Check the supported [configuration parameters](https://github.com/openvinotoolkit/openvino_contrib/tree/master/modules/nvidia_plugin#supported-configuration-parameters) and [supported layers](https://github.com/openvinotoolkit/openvino_contrib/tree/master/modules/nvidia_plugin#supported-layers-and-limitations)

docs/advanced_topics.md

@@ -1,17 +1,16 @@
 # Advanced Features {#ovms_docs_advanced}
 
-@sphinxdirective
-
-.. toctree::
-   :maxdepth: 1
-   :hidden:
-
-   ovms_sample_cpu_extension
-   ovms_docs_model_cache
-   ovms_docs_custom_loader
-   ovms_extras_nginx-mtls-auth-readme
-
-@endsphinxdirective
+```{toctree}
+---
+maxdepth: 1
+hidden:
+---
+
+ovms_sample_cpu_extension
+ovms_docs_model_cache
+ovms_docs_custom_loader
+ovms_extras_nginx-mtls-auth-readme
+```
 
 ## CPU Extensions
 Implement any CPU layer, that is not support by OpenVINO yet, as a shared library.

docs/api_reference_guide.md

@@ -1,18 +1,17 @@
 # API Reference Guide {#ovms_docs_server_api}
 
-@sphinxdirective
-
-.. toctree::
-   :maxdepth: 1
-   :hidden:
-
-   ovms_docs_grpc_api_tfs
-   ovms_docs_grpc_api_kfs
-   ovms_docs_rest_api_tfs
-   ovms_docs_rest_api_kfs
-   ovms_docs_c_api
-
-@endsphinxdirective
+```{toctree}
+---
+maxdepth: 1
+hidden:
+---
+
+ovms_docs_grpc_api_tfs
+ovms_docs_grpc_api_kfs
+ovms_docs_rest_api_tfs
+ovms_docs_rest_api_kfs
+ovms_docs_c_api
+```
 
 ## Introduction
 

docs/binary_input.md

@@ -1,17 +1,16 @@
 # Support for Binary Encoded Image Input Data {#ovms_docs_binary_input}
 
-@sphinxdirective
+```{toctree}
+---
+maxdepth: 1
+hidden:
+---
 
-.. toctree::
-   :maxdepth: 1
-   :hidden:
-
-   ovms_docs_binary_input_layout_and_shape
-   ovms_docs_binary_input_tfs
-   ovms_docs_binary_input_kfs
-   ovms_docs_demo_tensorflow_conversion
-
-@endsphinxdirective
+ovms_docs_binary_input_layout_and_shape
+ovms_docs_binary_input_tfs
+ovms_docs_binary_input_kfs
+ovms_docs_demo_tensorflow_conversion
+```
 
 While OpenVINO models don't have the ability to process images directly in their binary format, the model server can accept them and convert
 automatically from JPEG/PNG to OpenVINO friendly format using built-in [OpenCV](https://opencv.org/) library. To take advantage of this feature, there are two requirements:

docs/clients.md

@@ -1,14 +1,14 @@
 # Clients {#ovms_docs_clients}
 
-@sphinxdirective
-
-.. toctree::
-   :maxdepth: 1
-   :hidden:
-
-   ovms_docs_clients_tfs
-   ovms_docs_clients_kfs
-@endsphinxdirective
+```{toctree}
+---
+maxdepth: 1
+hidden:
+---
+
+ovms_docs_clients_tfs
+ovms_docs_clients_kfs
+```
 
 In this section you can find short code samples to interact with OpenVINO Model Server endpoints via:
 - [TensorFlow Serving API](./clients_tfs.md)