Consider recommending great-docs for documentation module
还没有人认领这个 Issue。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 35/100
- Issue 类型
- 文档
- 描述清晰度
- 需要澄清
- 活跃度
- 冷清
- 技术栈
- python
调研方向
首先找到当前介绍 MkDocs 的文档模块部分，然后阅读链接的 great-docs 文档和仓库。将其对 Python 3.11+ 的要求和基于 Quarto 的工作流与课程设置进行比较。当评估中记录了是否应推荐或添加 great-docs 的结论时，即视为完成。
由索引模型根据 Issue 内容生成。
描述
The documentation module currently covers MkDocs. great-docs from Posit is a new Python documentation site generator worth evaluating as an alternative or addition.
Why it's interesting for this course
- Built on Quarto — same toolchain the course already uses for slides
- Zero-config API reference — auto-discovers public API from docstrings (NumPy, Google, Sphinx formats)
- Minimal setup —
great-docs init/build/preview, no templates or manual page authoring needed - Modern defaults — dark mode, responsive, sidebar search, GitHub integration
- AI-ready — generates
llms.txtfiles
Links
- Documentation
- GitHub
- PyPI (requires Python 3.11+)
- 主要语言
- Jupyter Notebook
- 星标
- 8
- 派生
- 1
- 平均合并
- 4 分钟
- 30 天内合并 PR
- 1
贡献指南
这个仓库没有索引到贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
DHI/python-package-development 的其他 Issue
-
难度 2/5 1-2 天 新手友好度 88/100
-
难度 2/5 1-2 天 新手友好度 72/100
DHI/python-package-development#37 · 1 条评论 ·
-
难度 3/5 1-2 天 新手友好度 48/100
-
难度 2/5 1-3 小时 新手友好度 48/100
-
难度 3/5 1-2 天 新手友好度 48/100
查看 DHI/python-package-development 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 78/100
agilepathway/label-checker#640 ·
-
难度 2/5 1-3 小时 新手友好度 75/100
BasedHardware/omi#15662 · 1 条评论 ·
-
documentation help wanted
难度 2/5 1-3 小时 新手友好度 90/100
-
documentation good first issue
难度 2/5 1-3 小时 新手友好度 88/100
amponce/archive-movie-browser#167 ·
-
user-reported
难度 2/5 1-3 小时 新手友好度 85/100
Kong/developer.konghq.com#7316 ·