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+)
貢獻指南
這個儲存庫沒有索引到貢獻指南
研究方向
先找到目前介紹 MkDocs 的文件模組區段,然後閱讀連結的 great-docs 文件與儲存庫。將其對 Python 3.11+ 的需求與以 Quarto 為基礎的工作流程和課程設定進行比較。當評估中有記錄是否應推薦或加入 great-docs 的結論時,即表示完成。
由索引模型根據 Issue 內容生成。
評估
- 技術堆疊
- python
- 領域
- documentation
- Issue 類型
- 文件
- 難度
- 5/5
- 預估耗時
- 一週以上
- 活躍度
- 冷清
- 描述清晰度
- 需要釐清
- 新手友好度
- 35/100