jesp1999/heckbot

Add documentation generator integration

Aperta

#57 aperta il 4 feb 2023

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)Python (4 fork)auto 404
documentationgood first issuehelp wanted

Metriche repository

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

Descrizione

Either Sphinx, readthedocs, or Mkdocs will work. Slight preference towards readthedocs but I'm open to trying new things.

Sphinx startup: https://www.sphinx-doc.org/en/master/usage/quickstart.html Mkdocs startup: https://www.mkdocs.org/getting-started/ Readthedocs startup: https://docs.readthedocs.io/en/stable/tutorial/

Guida contributor

Direzione di ricerca
Scegli uno tra Sphinx, Mkdocs o Readthedocs, quindi segui la guida introduttiva per configurarlo per questo progetto Python. Concentrati sulla generazione di documentazione da docstring o sulla scrittura di nuova documentazione.
Tech stack
python
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
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.
Chiara
Prerequisiti
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
90