google/seq2seq

Generate Python API Documentation

Open

#24 aperta il 12 mar 2017

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

Metriche repository

Star
 (5587 star)
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
Il problema richiede la generazione di documentazione API dalle docstring Python. Innanzitutto, indaga strumenti come Sphinx o pydoc che possono produrre documentazione dall'aspetto gradevole. Determina come integrare la documentazione generata nella struttura di documentazione esistente. Fai riferimento all'issue #23 (che dovrebbe essere completata per prima) per il contesto. Controlla la configurazione di documentazione corrente del repository e qualsiasi file di configurazione esistente (ad esempio, docs/conf.py) per comprendere i punti di integrazione.
Tech stack
pythontensorflow
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 giorni
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Bloccata
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Richiede indagine
Prerequisiti
Complete issue #23
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
30