Fix build: Install kserve for rendering the docstring (#334)

* Update KServe python sdk docs Signed-off-by: Dan Sun <[email protected]> * Install kserve sdk for mkdocstring Signed-off-by: Dan Sun <[email protected]> --------- Signed-off-by: Dan Sun <[email protected]>
kserve · Jan 1, 2024 · aa186f9 · aa186f9
1 parent d20e3a3
commit aa186f9
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 3 deletions.
diff --git a/docs/python_runtime_api/docs/api.md b/docs/python_runtime_api/docs/api.md
@@ -0,0 +1,5 @@
+# KServe Python Serving Runtime API
+
+::: kserve.model_server
+::: kserve.model
+::: kserve.protocol.infer_type
diff --git a/docs/python_runtime_api/docs/index.md b/docs/python_runtime_api/docs/index.md
@@ -29,8 +29,8 @@ peotry install
 ```
 
 ## API Reference
-::: kserve.model_server
-::: kserve.model
+
+Please refer to [API docs](./api.md).
 
 ## Storage API
 The storage API is used by KServe `Storage Initializer` which supports the following cloud storage providers.
@@ -55,4 +55,4 @@ pip install kserve[storage]
 * Generic URI over either `HTTP` prefixed with `http://` or `HTTPS` prefixed with `https://`. 
   For example:
     * `https://<some_url>.com/model.joblib`
-    * `http://<some_url>.com/model.zip`
+    * `http://<some_url>.com/model.zip`
diff --git a/requirements.txt b/requirements.txt
@@ -7,3 +7,4 @@ mike>=1.1.2
 mkdocs-swagger-ui-tag
 markdown-include
 mkdocstrings-python
+kserve>=0.12.0rc0