pimutils/khal

figure out way to generate doc from cli.py

Aberta

#154 aberto em 4 de fev. de 2015

Ver no GitHubGuia do colaborador
 (8 comentários) (0 reação) (0 responsável)Python (191 forks)batch import
help wantedtype: enhancement

Métricas do repositório

Stars
 (2.349 estrelas)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

Description

so I basically want to generate /khal/doc/source/usage.rst from cli.py

Guia do colaborador

Direção de pesquisa
Explore cli.py para extrair comandos e argumentos da CLI, em seguida, use um gerador de documentação (ex: Sphinx autodoc, baseado em argparse) para produzir /khal/doc/source/usage.rst.
Pilha de tecnologia
python
Domain
cli
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.
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.
Ativo
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.
70