jesp1999/heckbot

Add documentation generator integration

Aberta

#57 aberto em 4 de fev. de 2023

Ver no GitHub
 (0 comentário) (0 reação) (0 responsável)Python (4 forks)auto 404
documentationgood first issuehelp wanted

Métricas do repositório

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

Description

Either Sphinx, readthedocs, or Mkdocs will work. Slight preference towards readthedocs but I'm open to trying new things.

Sphinx startup: https://www.sphinx-doc.org/en/master/usage/quickstart.html Mkdocs startup: https://www.mkdocs.org/getting-started/ Readthedocs startup: https://docs.readthedocs.io/en/stable/tutorial/

Guia do colaborador

Direção de pesquisa
Escolha um entre Sphinx, Mkdocs ou Readthedocs e siga o guia de início para configurá lo neste projeto Python. Foco em gerar documentação a partir de docstrings ou escrever nova documentação.
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.
1
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.
Claro
Prerequisites
Git
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
90