Consider recommending great-docs for documentation module

Aperta
#39 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
35/100
Tipo di issue
Documentazione
Chiarezza
Da chiarire
Stato di attività
Tranquilla
Stack tecnologico
python
Ambito
documentation

Direzione di ricerca

Inizia individuando la sezione del modulo di documentazione che attualmente tratta MkDocs, quindi leggi la documentazione e il repository di great-docs collegati. Confronta il requisito di Python 3.11+ e il workflow basato su Quarto con la configurazione del corso. Il lavoro è completo quando la valutazione contiene una conclusione documentata sull’opportunità di consigliare o aggiungere great-docs.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.txt files

Links

Lingua principale
Jupyter Notebook
Stelle
8
Fork
1
Merge medio
4m
PR unite (30g)
1

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di DHI/python-package-development

Tutte le issue di DHI/python-package-development

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.