pwr-Solaar/Solaar

Docs: Build developer docs from code

Open

#2503 aperta il 27 mag 2024

Vedi su GitHub
 (2 commenti) (0 reazioni) (0 assegnatari)Python (383 fork)batch import
enhancementhelp wanted

Metriche repository

Star
 (4528 star)
Metriche merge PR
 (Merge medio 1g 15h) (5 PR mergiate in 30 g)

Descrizione

Some code pieces already contain docstrings, which should be automatically compiled to documentation and published with GitHub pages on a page Developer documentation.

The numpydoc format is the preferred style.

Guida contributor

Direzione di ricerca
Configurare la generazione automatica della documentazione dalle stringhe di documentazione utilizzando il formato numpydoc e pubblicarla su GitHub Pages.
Tech stack
python
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
PythonGit
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75