From 44aa783c8062d76d36f19d1d28471d2e0aa64212 Mon Sep 17 00:00:00 2001
From: Matthias Reso <13337103+mreso@users.noreply.github.com>
Date: Mon, 3 Mar 2025 10:41:47 -0800
Subject: [PATCH] Fix sphinx docs (#3397)
---
README.md | 2 +-
docs/FAQs.md | 2 +-
docs/README.md | 2 +-
docs/Troubleshooting.md | 2 +-
docs/batch_inference_with_ts.md | 2 +-
docs/code_coverage.md | 2 +-
docs/configuration.md | 2 +-
docs/custom_service.md | 2 +-
docs/default_handlers.md | 2 +-
docs/genai_use_cases.md | 2 +-
docs/getting_started.md | 2 +-
docs/github_actions.md | 2 +-
docs/grpc_api.md | 2 +-
docs/hardware_support/amd_support.md | 2 +-
docs/hardware_support/apple_silicon_support.md | 2 +-
docs/hardware_support/linux_aarch64.md | 2 +-
docs/hardware_support/nvidia_mps.md | 2 +-
docs/index.rst | 5 ++++-
docs/inference_api.md | 2 +-
docs/internals.md | 2 +-
docs/large_model_inference.md | 2 +-
docs/llm_deployment.md | 2 +-
docs/logging.md | 2 +-
docs/management_api.md | 2 +-
docs/metrics.md | 2 +-
docs/metrics_api.md | 2 +-
docs/model_api_control.md | 2 +-
docs/model_loading.md | 2 +-
docs/model_zoo.md | 2 +-
docs/performance_checklist.md | 2 +-
docs/performance_guide.md | 2 +-
docs/request_envelopes.md | 2 +-
docs/rest_api.md | 2 +-
docs/server.md | 2 +-
docs/snapshot.md | 2 +-
docs/token_authorization_api.md | 2 +-
docs/torchserve_on_win_native.md | 2 +-
docs/torchserve_on_wsl.md | 2 +-
docs/use_cases.md | 2 +-
docs/workflow_inference_api.md | 2 +-
docs/workflow_management_api.md | 2 +-
docs/workflows.md | 2 +-
42 files changed, 45 insertions(+), 42 deletions(-)
diff --git a/README.md b/README.md
index ae75d436cd..afe21d8428 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-# ⚠️ Notice: Limited Maintenance
+ ⚠️ Notice: Limited Maintenance
This project is no longer actively maintained. While existing releases remain available, there are no planned updates, bug fixes, new features, or security patches. Users should be aware that vulnerabilities may not be addressed.
diff --git a/docs/FAQs.md b/docs/FAQs.md
index 1629c614df..68513d65c1 100644
--- a/docs/FAQs.md
+++ b/docs/FAQs.md
@@ -1,4 +1,4 @@
-# ⚠️ Notice: Limited Maintenance
+ ⚠️ Notice: Limited Maintenance
This project is no longer actively maintained. While existing releases remain available, there are no planned updates, bug fixes, new features, or security patches. Users should be aware that vulnerabilities may not be addressed.
diff --git a/docs/README.md b/docs/README.md
index d4ba5fc200..d00e726070 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -1,4 +1,4 @@
-# ⚠️ Notice: Limited Maintenance
+ ⚠️ Notice: Limited Maintenance
This project is no longer actively maintained. While existing releases remain available, there are no planned updates, bug fixes, new features, or security patches. Users should be aware that vulnerabilities may not be addressed.
diff --git a/docs/Troubleshooting.md b/docs/Troubleshooting.md
index 88457f5dc4..6d90ea139b 100644
--- a/docs/Troubleshooting.md
+++ b/docs/Troubleshooting.md
@@ -1,4 +1,4 @@
-# ⚠️ Notice: Limited Maintenance
+ ⚠️ Notice: Limited Maintenance
This project is no longer actively maintained. While existing releases remain available, there are no planned updates, bug fixes, new features, or security patches. Users should be aware that vulnerabilities may not be addressed.
diff --git a/docs/batch_inference_with_ts.md b/docs/batch_inference_with_ts.md
index 3b17d5e232..71690759cb 100644
--- a/docs/batch_inference_with_ts.md
+++ b/docs/batch_inference_with_ts.md
@@ -1,4 +1,4 @@
-# ⚠️ Notice: Limited Maintenance
+ ⚠️ Notice: Limited Maintenance
This project is no longer actively maintained. While existing releases remain available, there are no planned updates, bug fixes, new features, or security patches. Users should be aware that vulnerabilities may not be addressed.
diff --git a/docs/code_coverage.md b/docs/code_coverage.md
index 4c5fb4f34b..331a01ea37 100644
--- a/docs/code_coverage.md
+++ b/docs/code_coverage.md
@@ -1,4 +1,4 @@
-# ⚠️ Notice: Limited Maintenance
+ ⚠️ Notice: Limited Maintenance
This project is no longer actively maintained. While existing releases remain available, there are no planned updates, bug fixes, new features, or security patches. Users should be aware that vulnerabilities may not be addressed.
diff --git a/docs/configuration.md b/docs/configuration.md
index 49fb09b333..39d4e8848e 100644
--- a/docs/configuration.md
+++ b/docs/configuration.md
@@ -1,4 +1,4 @@
-# ⚠️ Notice: Limited Maintenance
+ ⚠️ Notice: Limited Maintenance
This project is no longer actively maintained. While existing releases remain available, there are no planned updates, bug fixes, new features, or security patches. Users should be aware that vulnerabilities may not be addressed.
diff --git a/docs/custom_service.md b/docs/custom_service.md
index bb88a0c046..2afcccfb69 100755
--- a/docs/custom_service.md
+++ b/docs/custom_service.md
@@ -1,4 +1,4 @@
-# ⚠️ Notice: Limited Maintenance
+ ⚠️ Notice: Limited Maintenance
This project is no longer actively maintained. While existing releases remain available, there are no planned updates, bug fixes, new features, or security patches. Users should be aware that vulnerabilities may not be addressed.
diff --git a/docs/default_handlers.md b/docs/default_handlers.md
index 14a91763ab..08094d8239 100644
--- a/docs/default_handlers.md
+++ b/docs/default_handlers.md
@@ -1,4 +1,4 @@
-# ⚠️ Notice: Limited Maintenance
+ ⚠️ Notice: Limited Maintenance
This project is no longer actively maintained. While existing releases remain available, there are no planned updates, bug fixes, new features, or security patches. Users should be aware that vulnerabilities may not be addressed.
diff --git a/docs/genai_use_cases.md b/docs/genai_use_cases.md
index a488bff174..51bfdf6877 100644
--- a/docs/genai_use_cases.md
+++ b/docs/genai_use_cases.md
@@ -1,4 +1,4 @@
-# ⚠️ Notice: Limited Maintenance
+ ⚠️ Notice: Limited Maintenance
This project is no longer actively maintained. While existing releases remain available, there are no planned updates, bug fixes, new features, or security patches. Users should be aware that vulnerabilities may not be addressed.
diff --git a/docs/getting_started.md b/docs/getting_started.md
index 606773ca4c..3f9e6176e2 100644
--- a/docs/getting_started.md
+++ b/docs/getting_started.md
@@ -1,4 +1,4 @@
-# ⚠️ Notice: Limited Maintenance
+ ⚠️ Notice: Limited Maintenance
This project is no longer actively maintained. While existing releases remain available, there are no planned updates, bug fixes, new features, or security patches. Users should be aware that vulnerabilities may not be addressed.
diff --git a/docs/github_actions.md b/docs/github_actions.md
index 5490e9a2a7..62800a23fd 100644
--- a/docs/github_actions.md
+++ b/docs/github_actions.md
@@ -1,4 +1,4 @@
-# ⚠️ Notice: Limited Maintenance
+ ⚠️ Notice: Limited Maintenance
This project is no longer actively maintained. While existing releases remain available, there are no planned updates, bug fixes, new features, or security patches. Users should be aware that vulnerabilities may not be addressed.
diff --git a/docs/grpc_api.md b/docs/grpc_api.md
index 58700dea84..f57e29b752 100644
--- a/docs/grpc_api.md
+++ b/docs/grpc_api.md
@@ -1,4 +1,4 @@
-# ⚠️ Notice: Limited Maintenance
+ ⚠️ Notice: Limited Maintenance
This project is no longer actively maintained. While existing releases remain available, there are no planned updates, bug fixes, new features, or security patches. Users should be aware that vulnerabilities may not be addressed.
diff --git a/docs/hardware_support/amd_support.md b/docs/hardware_support/amd_support.md
index daf89d4308..e231f4cae1 100644
--- a/docs/hardware_support/amd_support.md
+++ b/docs/hardware_support/amd_support.md
@@ -1,4 +1,4 @@
-# ⚠️ Notice: Limited Maintenance
+ ⚠️ Notice: Limited Maintenance
This project is no longer actively maintained. While existing releases remain available, there are no planned updates, bug fixes, new features, or security patches. Users should be aware that vulnerabilities may not be addressed.
diff --git a/docs/hardware_support/apple_silicon_support.md b/docs/hardware_support/apple_silicon_support.md
index 5e8686d7de..5930e8e3d0 100644
--- a/docs/hardware_support/apple_silicon_support.md
+++ b/docs/hardware_support/apple_silicon_support.md
@@ -1,4 +1,4 @@
-# ⚠️ Notice: Limited Maintenance
+ ⚠️ Notice: Limited Maintenance
This project is no longer actively maintained. While existing releases remain available, there are no planned updates, bug fixes, new features, or security patches. Users should be aware that vulnerabilities may not be addressed.
diff --git a/docs/hardware_support/linux_aarch64.md b/docs/hardware_support/linux_aarch64.md
index f185af5beb..5c40cabbcb 100644
--- a/docs/hardware_support/linux_aarch64.md
+++ b/docs/hardware_support/linux_aarch64.md
@@ -1,4 +1,4 @@
-# ⚠️ Notice: Limited Maintenance
+ ⚠️ Notice: Limited Maintenance
This project is no longer actively maintained. While existing releases remain available, there are no planned updates, bug fixes, new features, or security patches. Users should be aware that vulnerabilities may not be addressed.
diff --git a/docs/hardware_support/nvidia_mps.md b/docs/hardware_support/nvidia_mps.md
index f2a4787171..238467ebbf 100644
--- a/docs/hardware_support/nvidia_mps.md
+++ b/docs/hardware_support/nvidia_mps.md
@@ -1,4 +1,4 @@
-# ⚠️ Notice: Limited Maintenance
+ ⚠️ Notice: Limited Maintenance
This project is no longer actively maintained. While existing releases remain available, there are no planned updates, bug fixes, new features, or security patches. Users should be aware that vulnerabilities may not be addressed.
diff --git a/docs/index.rst b/docs/index.rst
index 0961a798e8..3b4bd23332 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -4,6 +4,9 @@ TorchServe
..
image:: Pytorch_logo.png
+**⚠️ Notice: Limited Maintenance**
+
+This project is no longer actively maintained. While existing releases remain available, there are no planned updates, bug fixes, new features, or security patches. Users should be aware that vulnerabilities may not be addressed.
TorchServe is a performant, flexible and easy to use tool for serving PyTorch models in production.
@@ -97,7 +100,7 @@ What's going on in TorchServe?
:card_description: Security Policy
:image: https://user-images.githubusercontent.com/880376/83180095-c44cc600-a0d7-11ea-97c1-23abb4cdbe4d.jpg
:link: security.html
- :tags: Security
+ :tags: Security
.. customcarditem::
:header: FAQs
diff --git a/docs/inference_api.md b/docs/inference_api.md
index bcb1ef6c25..316c865a0d 100644
--- a/docs/inference_api.md
+++ b/docs/inference_api.md
@@ -1,4 +1,4 @@
-# ⚠️ Notice: Limited Maintenance
+ ⚠️ Notice: Limited Maintenance
This project is no longer actively maintained. While existing releases remain available, there are no planned updates, bug fixes, new features, or security patches. Users should be aware that vulnerabilities may not be addressed.
diff --git a/docs/internals.md b/docs/internals.md
index 27a240185d..0073c6b3be 100644
--- a/docs/internals.md
+++ b/docs/internals.md
@@ -1,4 +1,4 @@
-# ⚠️ Notice: Limited Maintenance
+ ⚠️ Notice: Limited Maintenance
This project is no longer actively maintained. While existing releases remain available, there are no planned updates, bug fixes, new features, or security patches. Users should be aware that vulnerabilities may not be addressed.
diff --git a/docs/large_model_inference.md b/docs/large_model_inference.md
index e264801eea..3ab384df86 100644
--- a/docs/large_model_inference.md
+++ b/docs/large_model_inference.md
@@ -1,4 +1,4 @@
-# ⚠️ Notice: Limited Maintenance
+ ⚠️ Notice: Limited Maintenance
This project is no longer actively maintained. While existing releases remain available, there are no planned updates, bug fixes, new features, or security patches. Users should be aware that vulnerabilities may not be addressed.
diff --git a/docs/llm_deployment.md b/docs/llm_deployment.md
index dc653b7b58..e121cd9a89 100644
--- a/docs/llm_deployment.md
+++ b/docs/llm_deployment.md
@@ -1,4 +1,4 @@
-# ⚠️ Notice: Limited Maintenance
+ ⚠️ Notice: Limited Maintenance
This project is no longer actively maintained. While existing releases remain available, there are no planned updates, bug fixes, new features, or security patches. Users should be aware that vulnerabilities may not be addressed.
diff --git a/docs/logging.md b/docs/logging.md
index bf92d63822..36c6e3e414 100644
--- a/docs/logging.md
+++ b/docs/logging.md
@@ -1,4 +1,4 @@
-# ⚠️ Notice: Limited Maintenance
+ ⚠️ Notice: Limited Maintenance
This project is no longer actively maintained. While existing releases remain available, there are no planned updates, bug fixes, new features, or security patches. Users should be aware that vulnerabilities may not be addressed.
diff --git a/docs/management_api.md b/docs/management_api.md
index 7ab88b2914..338cef3867 100644
--- a/docs/management_api.md
+++ b/docs/management_api.md
@@ -1,4 +1,4 @@
-# ⚠️ Notice: Limited Maintenance
+ ⚠️ Notice: Limited Maintenance
This project is no longer actively maintained. While existing releases remain available, there are no planned updates, bug fixes, new features, or security patches. Users should be aware that vulnerabilities may not be addressed.
diff --git a/docs/metrics.md b/docs/metrics.md
index 79726ecf93..06d4321e9a 100644
--- a/docs/metrics.md
+++ b/docs/metrics.md
@@ -1,4 +1,4 @@
-# ⚠️ Notice: Limited Maintenance
+ ⚠️ Notice: Limited Maintenance
This project is no longer actively maintained. While existing releases remain available, there are no planned updates, bug fixes, new features, or security patches. Users should be aware that vulnerabilities may not be addressed.
diff --git a/docs/metrics_api.md b/docs/metrics_api.md
index 4062b4173b..6760c00c76 100644
--- a/docs/metrics_api.md
+++ b/docs/metrics_api.md
@@ -1,4 +1,4 @@
-# ⚠️ Notice: Limited Maintenance
+ ⚠️ Notice: Limited Maintenance
This project is no longer actively maintained. While existing releases remain available, there are no planned updates, bug fixes, new features, or security patches. Users should be aware that vulnerabilities may not be addressed.
diff --git a/docs/model_api_control.md b/docs/model_api_control.md
index f29ced02ec..2078772cef 100644
--- a/docs/model_api_control.md
+++ b/docs/model_api_control.md
@@ -1,4 +1,4 @@
-# ⚠️ Notice: Limited Maintenance
+ ⚠️ Notice: Limited Maintenance
This project is no longer actively maintained. While existing releases remain available, there are no planned updates, bug fixes, new features, or security patches. Users should be aware that vulnerabilities may not be addressed.
diff --git a/docs/model_loading.md b/docs/model_loading.md
index 087f998cc0..84495fdfad 100644
--- a/docs/model_loading.md
+++ b/docs/model_loading.md
@@ -1,4 +1,4 @@
-# ⚠️ Notice: Limited Maintenance
+ ⚠️ Notice: Limited Maintenance
This project is no longer actively maintained. While existing releases remain available, there are no planned updates, bug fixes, new features, or security patches. Users should be aware that vulnerabilities may not be addressed.
diff --git a/docs/model_zoo.md b/docs/model_zoo.md
index 526bc7fb97..944e311081 100644
--- a/docs/model_zoo.md
+++ b/docs/model_zoo.md
@@ -1,4 +1,4 @@
-# ⚠️ Notice: Limited Maintenance
+ ⚠️ Notice: Limited Maintenance
This project is no longer actively maintained. While existing releases remain available, there are no planned updates, bug fixes, new features, or security patches. Users should be aware that vulnerabilities may not be addressed.
diff --git a/docs/performance_checklist.md b/docs/performance_checklist.md
index c0ef99bafd..32536d50f2 100644
--- a/docs/performance_checklist.md
+++ b/docs/performance_checklist.md
@@ -1,4 +1,4 @@
-# ⚠️ Notice: Limited Maintenance
+ ⚠️ Notice: Limited Maintenance
This project is no longer actively maintained. While existing releases remain available, there are no planned updates, bug fixes, new features, or security patches. Users should be aware that vulnerabilities may not be addressed.
diff --git a/docs/performance_guide.md b/docs/performance_guide.md
index d5da040f07..a342eeaee1 100644
--- a/docs/performance_guide.md
+++ b/docs/performance_guide.md
@@ -1,4 +1,4 @@
-# ⚠️ Notice: Limited Maintenance
+ ⚠️ Notice: Limited Maintenance
This project is no longer actively maintained. While existing releases remain available, there are no planned updates, bug fixes, new features, or security patches. Users should be aware that vulnerabilities may not be addressed.
diff --git a/docs/request_envelopes.md b/docs/request_envelopes.md
index 85dfddbd7f..cee43ba7ec 100644
--- a/docs/request_envelopes.md
+++ b/docs/request_envelopes.md
@@ -1,4 +1,4 @@
-# ⚠️ Notice: Limited Maintenance
+ ⚠️ Notice: Limited Maintenance
This project is no longer actively maintained. While existing releases remain available, there are no planned updates, bug fixes, new features, or security patches. Users should be aware that vulnerabilities may not be addressed.
diff --git a/docs/rest_api.md b/docs/rest_api.md
index a747119ea9..a23d8e62f0 100644
--- a/docs/rest_api.md
+++ b/docs/rest_api.md
@@ -1,4 +1,4 @@
-# ⚠️ Notice: Limited Maintenance
+ ⚠️ Notice: Limited Maintenance
This project is no longer actively maintained. While existing releases remain available, there are no planned updates, bug fixes, new features, or security patches. Users should be aware that vulnerabilities may not be addressed.
diff --git a/docs/server.md b/docs/server.md
index fef4bfa465..da4273f09f 100644
--- a/docs/server.md
+++ b/docs/server.md
@@ -1,4 +1,4 @@
-# ⚠️ Notice: Limited Maintenance
+ ⚠️ Notice: Limited Maintenance
This project is no longer actively maintained. While existing releases remain available, there are no planned updates, bug fixes, new features, or security patches. Users should be aware that vulnerabilities may not be addressed.
diff --git a/docs/snapshot.md b/docs/snapshot.md
index e03a6705cd..ab5e13325b 100644
--- a/docs/snapshot.md
+++ b/docs/snapshot.md
@@ -1,4 +1,4 @@
-# ⚠️ Notice: Limited Maintenance
+ ⚠️ Notice: Limited Maintenance
This project is no longer actively maintained. While existing releases remain available, there are no planned updates, bug fixes, new features, or security patches. Users should be aware that vulnerabilities may not be addressed.
diff --git a/docs/token_authorization_api.md b/docs/token_authorization_api.md
index 647bd02348..222afcf51b 100644
--- a/docs/token_authorization_api.md
+++ b/docs/token_authorization_api.md
@@ -1,4 +1,4 @@
-# ⚠️ Notice: Limited Maintenance
+ ⚠️ Notice: Limited Maintenance
This project is no longer actively maintained. While existing releases remain available, there are no planned updates, bug fixes, new features, or security patches. Users should be aware that vulnerabilities may not be addressed.
diff --git a/docs/torchserve_on_win_native.md b/docs/torchserve_on_win_native.md
index b3e3022af2..ed7b53ed0a 100644
--- a/docs/torchserve_on_win_native.md
+++ b/docs/torchserve_on_win_native.md
@@ -1,4 +1,4 @@
-# ⚠️ Notice: Limited Maintenance
+ ⚠️ Notice: Limited Maintenance
This project is no longer actively maintained. While existing releases remain available, there are no planned updates, bug fixes, new features, or security patches. Users should be aware that vulnerabilities may not be addressed.
diff --git a/docs/torchserve_on_wsl.md b/docs/torchserve_on_wsl.md
index 3cda32ef53..aa92edbe3c 100644
--- a/docs/torchserve_on_wsl.md
+++ b/docs/torchserve_on_wsl.md
@@ -1,4 +1,4 @@
-# ⚠️ Notice: Limited Maintenance
+ ⚠️ Notice: Limited Maintenance
This project is no longer actively maintained. While existing releases remain available, there are no planned updates, bug fixes, new features, or security patches. Users should be aware that vulnerabilities may not be addressed.
diff --git a/docs/use_cases.md b/docs/use_cases.md
index 19f2b9286c..cf58baf30a 100644
--- a/docs/use_cases.md
+++ b/docs/use_cases.md
@@ -1,4 +1,4 @@
-# ⚠️ Notice: Limited Maintenance
+ ⚠️ Notice: Limited Maintenance
This project is no longer actively maintained. While existing releases remain available, there are no planned updates, bug fixes, new features, or security patches. Users should be aware that vulnerabilities may not be addressed.
diff --git a/docs/workflow_inference_api.md b/docs/workflow_inference_api.md
index c28bf657b4..087a9f713b 100644
--- a/docs/workflow_inference_api.md
+++ b/docs/workflow_inference_api.md
@@ -1,4 +1,4 @@
-# ⚠️ Notice: Limited Maintenance
+ ⚠️ Notice: Limited Maintenance
This project is no longer actively maintained. While existing releases remain available, there are no planned updates, bug fixes, new features, or security patches. Users should be aware that vulnerabilities may not be addressed.
diff --git a/docs/workflow_management_api.md b/docs/workflow_management_api.md
index 6da69d3fae..0a7de8ec3b 100644
--- a/docs/workflow_management_api.md
+++ b/docs/workflow_management_api.md
@@ -1,4 +1,4 @@
-# ⚠️ Notice: Limited Maintenance
+ ⚠️ Notice: Limited Maintenance
This project is no longer actively maintained. While existing releases remain available, there are no planned updates, bug fixes, new features, or security patches. Users should be aware that vulnerabilities may not be addressed.
diff --git a/docs/workflows.md b/docs/workflows.md
index 7eb046873d..3a34b4a3bd 100644
--- a/docs/workflows.md
+++ b/docs/workflows.md
@@ -1,4 +1,4 @@
-# ⚠️ Notice: Limited Maintenance
+ ⚠️ Notice: Limited Maintenance
This project is no longer actively maintained. While existing releases remain available, there are no planned updates, bug fixes, new features, or security patches. Users should be aware that vulnerabilities may not be addressed.