refactor docs

Signed-off-by: cutecutecat <junyuchen@tensorchord.ai>

.github/workflows/python-check.yml

@@ -35,14 +35,17 @@ jobs:
         python-version: "3.10"
     - name: Install dependencies
       run: |
-        pdm sync -d -G lint
+        pdm sync -d -G lint -G generate -G doc
     - name: Lint
       run: |
         pdm run lint --exclude openapi
-    - name: Verify openapi generate
+    - name: Verify OpenAPI generate
       run: |
-        make generate && git add * &&
+        pdm run generate && git add openapi &&
         git diff --cached --exit-code || (echo 'Please run "make generate" to verify generate' && exit 1)
+    - name: Verify docs generate
+      run: |
+        pdm run docs
 
   test:
     runs-on: ${{ matrix.os }}

docs/source/api.rst

@@ -8,7 +8,4 @@ Python SDK interface
    :members:
 
 .. autoclass:: modelz.openapi_client.DeploymentClient
-   :members:
-
-.. automodule:: openapi.sdk.models
    :members:

docs/source/index.rst

@@ -7,12 +7,13 @@ Welcome to modelz's documentation!
 =====================================
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 3
    :caption: Reference:
    :hidden:
 
-   api
    cli
+   api
+   openapi
 
 
 ``modelz`` is a Python package for calling model prediction and management APIs that are on the modelz_ platform. We provide both Python SDK and CLI interface.

docs/source/openapi.rst

@@ -0,0 +1,5 @@
+OpenAPI DataClass
+====================================
+
+.. automodule:: openapi.sdk.models
+   :members:

pyproject.toml

@@ -41,6 +41,7 @@ black = "black --check modelz"
 ruff = "ruff check ."
 lint = {composite = ["black", "ruff"]}
 doc = "make docs"
+generate = "make generate"
 [tool.pdm.dev-dependencies]
 lint = [
     "ruff>=0.0.252",