Use mkdocstrings for documenting Python code
還沒有人認領這個 Issue。
評估
- 難度
- 5/5
- 預估耗時
- 一週以上
- 新手友好度
- 30/100
- Issue 類型
- 功能
- 描述清晰度
- 基本清楚
- 活躍度
- 停滯
- 技術堆疊
- python
研究方向
Review the current manually maintained Python API documentation and the proposed mkdocstrings approach first. Check mkdocstrings/mkdocstrings#450 and #466 to determine whether the blockers are resolved. Done means the docs are generated from Python code, type hints, and docstrings without API-to-documentation mismatches.
由索引模型根據 Issue 內容生成。
描述
Current Situation
Currently, our Python APIs are manually added to the docs, which can potentially result in API <-> Docs mismatch.
Proposed Actions
Use mkdocstrings within the docs to automatically generate markdown based on Python code, type hints, and docstrings.
Implementing this is currently blocked by these issues:
- mkdocstrings/mkdocstrings#450
- mkdocstrings/mkdocstrings#466
- 主要語言
- Python
- 星號
- 357
- 分支
- 22
- 平均合併
- 10 小時 31 分鐘
- 30 天內合併 PR
- 2
貢獻指南
這個儲存庫沒有索引到貢獻指南
從這裡開始
- 先讀完整個 Issue，再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫，在一個分支上完成修改。
- 送出 Pull Request，並在描述裡引用這個 Issue 編號。
reactive-python/reactpy-django 的其他 Issue
-
complexity: 3 (low) priority: 3 (low) type: ci
難度 3/5 1-2 天 新手友好度 45/100
-
complexity: 1 (high) priority: 1 (high)
難度 5/5 一週以上 新手友好度 25/100
-
complexity: 2 (medium) priority: 3 (low)
難度 5/5 一週以上 新手友好度 25/100
-
complexity: 2 (medium) priority: 3 (low)
難度 5/5 一週以上 新手友好度 25/100
-
complexity: 1 (high) priority: 2 (moderate)
難度 5/5 一週以上 新手友好度 25/100
查看 reactive-python/reactpy-django 的全部 Issue
相似的 Issue
-
bug
難度 2/5 1-3 小時 新手友好度 86/100
zostera/django-bootstrap4#894 ·
-
難度 2/5 1-3 小時 新手友好度 78/100
use-agent-os/agent-os#3276 ·
-
難度 2/5 1-3 小時 新手友好度 88/100
zephyrproject-rtos/zephyr#119726 ·
-
area/auth bug comp/agent P3 platform/discord type/security
難度 2/5 1-3 小時 新手友好度 88/100
NousResearch/hermes-agent#117848 ·
-
難度 2/5 1-3 小時 新手友好度 82/100
zilliztech/memsearch#759 ·