google/seq2seq

Generate Python API Documentation

Open

#24 ouverte le 12 mars 2017

Voir sur GitHub
 (0 commentaires) (0 réactions) (0 assignés)Python (5 587 stars) (1 329 forks)batch import
dochelp wanted

Description

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.

Guide contributeur

Stack technique
pythontensorflow
Domaine
documentation
Type d'issue
documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-2 days
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
blocked
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
needs investigation
Prérequis
Complete issue #23
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
30
Direction de recherche
The issue requires generating API documentation from Python docstrings. First, investigate tools like Sphinx or pydoc that can produce nice looking documentation. Determine how to integrate the generated docs into the existing documentation structure. Refer to issue #23 (which should be completed first) for context. Check the repository's current documentation setup and any existing configuration files (e.g., docs/conf.py) to understand the integration points.