google/seq2seq

Generate Python API Documentation

Open

#24 opened on Mar 12, 2017

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)Python (1,329 forks)batch import
dochelp wanted

Repository metrics

Stars
 (5,587 stars)
PR merge metrics
 (PR metrics pending)

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.

Contributor guide

Research direction
Investigate tools like Sphinx or pdoc to generate API documentation from PyDoc strings. Determine how to style the documentation and integrate it into the existing project documentation.
Tech stack
python
Domain
documentation
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
PythonGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65