[Feature Request] Look into alternative API doc generators
維護者通常 1 天內回覆
還沒有人認領這個 Issue。
評估
- 難度
- 5/5
- 預估耗時
- 一週以上
- 新手友好度
- 35/100
- Issue 類型
- 功能
- 描述清晰度
- 需要釐清
- 活躍度
- 冷清
- 技術堆疊
- python
研究方向
首先檢視 python.temporal.io 上目前由 pydoctor 產生的頁面，尤其是 WorkerDeploymentConfig，並比較 pdoc 等替代的純 Python API 文件產生器。評估每個產生器是否保留所要求的純 API 文件重點，並正確記錄包括 default_versioning_behavior 在內的 dataclass 欄位；完成的標準是形成有文件記錄的建議或遷移路徑。
由索引模型根據 Issue 內容生成。
描述
Describe the solution you'd like
We should consider moving away from https://github.com/twisted/pydoctor for Python API docs. It was originally chosen because of how well it handled @overloads. But it doesn't really get updated much and is a bit buggy, e.g. https://python.temporal.io/temporalio.worker.WorkerDeploymentConfig.html is showing those as class variables (because it doesn't understand data classes) and is even missing default_versioning_behavior that is in source with a default.
Open to all options, but I think we want pure API docs generator, not like Sphinx where English docs come along with, but it's worth a try so long as python.temporal.io is pure API docs. Maybe also try https://pdoc.dev/. Or just check around the ecosystem.
- 主要語言
- Python
- 星號
- 1.2k
- 分支
- 285
- 平均合併
- 1 天 21 小時
- 30 天內合併 PR
- 80
環境準備
- 沒有 Dockerfile 或 Docker Compose 檔案
- 沒有 Pull Request 範本
- 閱讀貢獻指南
從這裡開始
- 先讀完整個 Issue，再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫，在一個分支上完成修改。
- 送出 Pull Request，並在描述裡引用這個 Issue 編號。
temporalio/sdk-python 的其他 Issue
-
難度 4/5 3-5 天 新手友好度 58/100
temporalio/sdk-python#2092 ·
維護者通常 1 天內回覆
-
難度 4/5 3-5 天 新手友好度 18/100
temporalio/sdk-python#2080 ·
維護者通常 1 天內回覆
-
[Bug] Sandboxed datetime hints can fail decoding and drop signals可能已有人在做 @VegetarianOrc 於 2 天前認領。 未關閉sdk-python
temporalio/sdk-python#2072 · 已指派 1 人 ·
維護者通常 1 天內回覆
-
[Bug] TaskGroup cancellation of mixed Temporal operations can break replay可能已有人在做 @VegetarianOrc 於 2 天前認領。 未關閉sdk-python
temporalio/sdk-python#2069 · 已指派 1 人 ·
維護者通常 1 天內回覆
-
sdk-python
難度 4/5 3-5 天 新手友好度 22/100
temporalio/sdk-python#2067 · 2 則留言 ·
維護者通常 1 天內回覆
查看 temporalio/sdk-python 的全部 Issue
相似的 Issue
-
request-theme
難度 1/5 1 小時以內 新手友好度 78/100
LizardByte/ThemerrDB#9883 ·
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 84/100
Project-MONAI/MONAI#9258 ·
維護者通常 3 天內回覆
-
catalog:deprecation
難度 1/5 1 小時以內 新手友好度 88/100
surendranb/free-inference#31 ·
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 78/100
fritzprix/libr-agent#2612 ·
維護者通常 1 天內回覆
-
needs-triage presubmit-gate
難度 2/5 1-3 小時 新手友好度 76/100
gke-labs/kube-agents#5001 ·
維護者通常 1 天內回覆