DHI / DHI/python-package-development
Consider recommending great-docs for documentation module
- 主要语言
- Jupyter Notebook
- 星标
- 8
- 派生
- 1
- 平均合并
- 4 分钟
- 30 天内合并 PR
- 1
描述
The documentation module currently covers MkDocs. [great-docs](https://github.com/posit-dev/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.txt` files
## Links
- [Documentation](https://posit-dev.github.io/great-docs/)
- [GitHub](https://github.com/posit-dev/great-docs)
- [PyPI](https://pypi.org/project/great-docs/) (requires Python 3.11+)
贡献指南
这个仓库没有索引到贡献指南
调研方向
Start by locating the documentation module section that currently covers MkDocs, then read the linked great-docs documentation and repository. Compare its Python 3.11+ requirement and Quarto-based workflow with the course setup. Done means the evaluation has a documented conclusion about whether great-docs should be recommended or added.
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- python
- 领域
- documentation
- Issue 类型
- 文档
- 难度
- 5/5
- 预计耗时
- 一周以上
- 活跃度
- 冷清
- 描述清晰度
- 需要澄清
- 新手友好度
- 35/100