DHI / DHI/python-package-development
Consider recommending great-docs for documentation module
- Dominant language
- Jupyter Notebook
- Stars
- 8
- Forks
- 1
- Avg merge
- 4m
- Merged PRs (30d)
- 1
Description
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+)
Contributor guide
No contributing guide indexed for this repository
Assessment
This issue has not been assessed yet.