google/seq2seq

Generate Python API Documentation

Offen

#24 geöffnet am 12.03.2017

Auf GitHub ansehenContributor Guide
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Python (1.329 Forks)batch import
dochelp wanted

Repository-Metriken

Stars
 (5.587 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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.

Contributor Guide

Research-Richtung
Untersuchen Sie Tools wie Sphinx oder pdoc, um API Dokumentation aus PyDoc Strings zu generieren. Bestimmen Sie, wie die Dokumentation gestaltet und in die vorhandene Projektdokumentation integriert werden kann.
Tech Stack
python
Domain
documentation
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Meist klar
Voraussetzungen
PythonGit
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
65