Consider recommending great-docs for documentation module
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 5/5
- Temps estimé
- Plus d'une semaine
- Accessibilité débutants
- 35/100
- Type d'issue
- Documentation
- Clarté
- À clarifier
- Activité
- Calme
- Stack technique
- python
- Domaine
- documentation
Piste de recherche
Commencez par localiser la section du module de documentation qui couvre actuellement MkDocs, puis lisez la documentation et le dépôt de great-docs liés. Comparez son exigence de Python 3.11+ et son workflow basé sur Quarto avec la configuration du cours. La tâche est terminée lorsque l’évaluation contient une conclusion documentée indiquant s’il faut recommander ou ajouter great-docs.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
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+)
- Langage dominant
- Jupyter Notebook
- Étoiles
- 8
- Forks
- 1
- Merge moyen
- 4 min
- PR mergées (30 j)
- 1
Guide de contribution
Aucun guide de contribution indexé pour ce dépôt
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de DHI/python-package-development
-
Difficulté 2/5 1-2 jours Accessibilité débutants 88/100
-
Difficulté 2/5 1-2 jours Accessibilité débutants 72/100
DHI/python-package-development#37 · 1 commentaire ·
-
Difficulté 3/5 1-2 jours Accessibilité débutants 48/100
-
Difficulté 2/5 1-3 heures Accessibilité débutants 48/100
-
Difficulté 3/5 1-2 jours Accessibilité débutants 48/100
Toutes les issues de DHI/python-package-development
Issues similaires
-
documentation help wanted
Difficulté 2/5 1-3 heures Accessibilité débutants 90/100
-
user-reported
Difficulté 2/5 1-3 heures Accessibilité débutants 85/100
Kong/developer.konghq.com#7316 ·
-
Difficulté 2/5 1-3 heures Accessibilité débutants 88/100
HarperFast/skills#96 ·
-
Client support matrix inclusion Ouverteenhancement
Difficulté 2/5 1-3 heures Accessibilité débutants 68/100
-
Difficulté 2/5 1-3 heures Accessibilité débutants 82/100
infinispan/infinispan#18150 ·