update pydoc

longportapp · Feb 5, 2025 · 6eef0bf · 6eef0bf
1 parent dc7d3f4
commit 6eef0bf
Show file tree

Hide file tree

Showing 8 changed files with 15 additions and 28 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -20,7 +20,7 @@ jobs:
           components: rust-docs
       - uses: actions/setup-python@v5
         with:
-          python-version: "3.9"
+          python-version: "3.13"
       - name: Setup node
         uses: actions/setup-node@v3
         with:
@@ -45,7 +45,7 @@ jobs:
         uses: PyO3/maturin-action@v1
         with:
           target: "x86_64"
-          args: -i python3.9 --out dist -m python/Cargo.toml
+          args: -i python3.13 --out dist -m python/Cargo.toml
       - name: Install built wheel
         run: |
           pip install longport --no-index --find-links dist --force-reinstall

diff --git a/python/docs/config.md b/python/docs/config.md
diff --git a/python/docs/index.md b/python/docs/index.md
@@ -4,15 +4,15 @@
 
 ## References
 
-- [Config](https://longportapp.github.io/openapi-sdk/python/config/)
+- [Config](reference_all.md#longport.openapi.Config)
 
   The configuration of the SDK.
 
-- [QuoteContext](https://longportapp.github.io/openapi-sdk/python/quote_context/)
+- [QuoteContext](reference_all.md#longport.openapi.QuoteContext)
 
   The Quote API part of the SDK, e.g.: get basic information of securities, subscribe quotes...
 
-- [TradeContext](https://longportapp.github.io/openapi-sdk/python/trade_context/)
+- [TradeContext](reference_all.md#longport.openapi.TradeContext)
 
   The Trade API part of the SDK, e.g.: submit order, get order status...
 

diff --git a/python/docs/quote_context.md b/python/docs/quote_context.md
diff --git a/python/docs/requirements.txt b/python/docs/requirements.txt
@@ -1,5 +1,5 @@
-mkdocs==1.3.0
-mkdocstrings==0.18.1
-mkdocstrings-python==0.6.6
-Jinja2==3.1.0
-semver==2.13.0
+mkdocs>=1.6.1
+mkdocstrings>=0.28.0
+mkdocstrings-python>=1.14.4
+Jinja2>=3.1.5
+semver>=3.0.4
diff --git a/python/docs/trade_context.md b/python/docs/trade_context.md
diff --git a/python/mkdocs.yml b/python/mkdocs.yml
@@ -1,15 +1,12 @@
 site_name: LongPort OpenAPI SDK
 docs_dir: docs
 
-# theme:
-#   name: readthedocs
+theme:
+  name: readthedocs
 
 nav:
   - Index: index.md
   - Code Reference:
-      - Config: config.md
-      - QuoteContext: quote_context.md
-      - TradeContext: trade_context.md
       - All: reference_all.md
 
 markdown_extensions:
@@ -24,11 +21,10 @@ plugins:
   - mkdocstrings:
       handlers:
         python:
-          import:
+          inventories:
             - https://docs.python.org/3/objects.inv
-          selection:
+          options:
             docstring_style: google
-          rendering:
             show_source: false
             show_if_no_docstring: true
             members_order: source

diff --git a/python/pysrc/longport/openapi.pyi b/python/pysrc/longport/openapi.pyi
@@ -5178,7 +5178,7 @@ class TradeContext:
         Get order detail
 
         Args:
-            order id: Order id
+            order_id: Order id
 
         Returns:
             Order detail