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 (1.329 forks)batch import
dochelp wanted

Métricas do repositório

Stars
 (5.587 stars)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

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

Direção de pesquisa
Pesquise ferramentas como Sphinx ou pdoc para gerar documentação de API a partir de strings PyDoc. Determine como estilizar a documentação e integrá la à documentação existente do projeto.
Pilha de tecnologia
python
Domain
documentation
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Recente
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Principalmente claro
Prerequisites
PythonGit
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
65