google/seq2seq

Generate Python API Documentation

Aperta

#24 aperta il 12 mar 2017

Vedi su GitHubGuida contributor
 (0 commenti) (0 reazioni) (0 assegnatari)Python (1329 fork)batch import
dochelp wanted

Metriche repository

Star
 (5587 stelle)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

We should generate a proper API documentation based on PyDoc strings. The question are:

  1. How to make it look nice?
  2. How to integrate it into the documentation?

Should finished #23 before doing this.

Guida contributor

Direzione di ricerca
Esplora strumenti come Sphinx o pdoc per generare documentazione API dalle stringhe PyDoc. Determina come abbellire la documentazione e integrarla nella documentazione esistente del progetto.
Tech stack
python
Dominio
documentation
Tipo issue
Funzionalità
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
PythonGit
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
65