guyzmo/git-repo

Write more thorough documentation

Open

#146 aberto em 21 de mar. de 2017

Ver no GitHub
 (1 comment) (0 reactions) (0 assignees)Python (86 forks)batch import
enhancementgood first issuehelp wanted

Métricas do repositório

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

Description

  • make a full sphinx documentation for the project with
    • proper manual on how to use it (and why not generate a manpage?)
    • documentation of internals
    • upload of all of it on readthedocs

Guia do colaborador

Direção de pesquisa
Configure a estrutura de documentação Sphinx no projeto, crie um manual de uso adequado e uma página man, documente os detalhes internos e configure a integração com o Read the Docs. Consulte a estrutura e o conteúdo da documentação de projetos Python semelhantes.
Pilha de tecnologia
python
Domain
documentation
Tipo Issue
Documentação
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.
3-5 dias
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Antigo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
PythonSphinx
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70