DHI / DHI/python-package-development

Consider recommending great-docs for documentation module

Ouverte
#39 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
Langage dominant
Jupyter Notebook
Étoiles
8
Forks
1
Merge moyen
4 min
PR mergées (30 j)
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+)

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Piste de recherche

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.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
python
Domaine
documentation
Type d'issue
Documentation
Difficulté
5/5
Temps estimé
Plus d'une semaine
Activité
Calme
Clarté
À clarifier
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.