google/seq2seq

Generate Python API Documentation

Ouverte

#24 ouverte le 12 mars 2017

Voir sur GitHubGuide contributeur
 (0 commentaire) (0 réaction) (0 personne assignée)Python (1 329 forks)batch import
dochelp wanted

Métriques du dépôt

Stars
 (5 587 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

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

Direction de recherche
Étudiez des outils comme Sphinx ou pdoc pour générer une documentation API à partir des chaînes PyDoc. Déterminez comment embellir la documentation et l'intégrer dans la documentation existante du projet.
Stack technique
python
Domaine
documentation
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Plutôt claire
Prérequis
PythonGit
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
65