lundybernard/batconf

Cleanup Sphinx documentation

Aperta

#32 aperta il 27 lug 2024

Vedi su GitHub
 (1 commento) (0 reazioni) (0 assegnatari)Python (3 fork)auto 404
good first issue

Metriche repository

Star
 (5 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

The documentation needs to be reviewed and cleaned up. Feel free to take on smaller tasks and open new Issues to track them.

Some things that need improvement:

  • Auto-generated API documentation
  • Add a detailed User Guide
  • Enable make docs from the project's root directory, so we don't need to cd into docs/

Guida contributor

Direzione di ricerca
Rivedi la documentazione Sphinx esistente, identifica le lacune nella documentazione API generata automaticamente e nella guida utente, e implementa i miglioramenti suggeriti.
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.
1-3 ore
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
Nessuno
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75