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
-
link-check link-check:sphinx-theme
难度 2/5 1-3 小时 新手友好度 72/100
-
难度 2/5 1-3 小时 新手友好度 65/100
qgis/QGIS-Documentation#11275 ·
-
bug priority:normal ready-for-dev
难度 2/5 1-3 小时 新手友好度 88/100
OpenHands/extensions#626 · 1 条评论 ·
-
难度 1/5 1 小时以内 新手友好度 90/100
CSCfi/sd-search-api#39 ·
-
难度 1/5 1 小时以内 新手友好度 90/100