google/seq2seq

Generate Python API Documentation

Open

#24 opened on Mar 12, 2017

View on GitHub
 (0 comments) (0 reactions) (0 assignees)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.

Contributor guide

Tech stack
pythontensorflow
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
blocked
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
needs investigation
Prerequisites
Complete issue #23
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
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.