rucio/documentation

Investigate replacements for MKDocs

Open

#840 aperta il 7 lug 2026

Vedi su GitHub
 (0 commenti) (0 reazioni) (1 assegnatario)Python (67 fork)auto 404
Discussion neededhelp wanted

Metriche repository

Star
 (4 star)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

Mkdocs 2.0 looks like it may cause problems for the py client documentation (e.g. autodoc plugins will probably break), according to the Material blog

The blog itself is pretty biased but it raises some good points, so we should investigate some replacements.

Guida contributor

Direzione di ricerca
Ricerca generatori di siti statici alternativi per la documentazione che funzionino bene con i plugin autodoc di Python, come Sphinx o altri. Confronta caratteristiche, compatibilità dei plugin e sforzo di migrazione.
Tech stack
python
Dominio
documentation
Tipo issue
Ricerca
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Abbastanza chiara
Prerequisiti
PythonMKDocs
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70