google/seq2seq

Generate Python API Documentation

Open

#24 aberto em 12 de mar. de 2017

Ver no 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.

Guia do colaborador

Pilha de tecnologia
pythontensorflow
Domain
documentation
Tipo Issue
documentation
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-2 days
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
blocked
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
needs investigation
Prerequisites
Complete issue #23
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
30
Direção de pesquisa
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.