microsoft/vasim

TODO: setup documentation generation

Aperta

#5 aperta il 30 ago 2024

Vedi su GitHubGuida contributor
 (1 commento) (0 reazioni) (0 assegnatari)Python (7 fork)auto 404
TODOdocumentationhelp wanted

Metriche repository

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

Descrizione

As we slowly add the documentation, we also should setup auto doc generation. The pipeline code is in place. This particular setup uses sphinx but there are many options we could chose from.

Guida contributor

Direzione di ricerca
Configura la generazione della documentazione con Sphinx: crea la directory 'docs', aggiungi conf.py, index.rst e configura la distribuzione su GitHub Pages o Read the Docs.
Tech stack
python
Dominio
developer experience
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.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
PythonSphinx
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80