lundybernard/batconf

Cleanup Sphinx documentation

Aberta

#32 aberto em 27 de jul. de 2024

Ver no GitHub
 (1 comentário) (0 reação) (0 responsável)Python (3 forks)auto 404
good first issue

Métricas do repositório

Stars
 (5 estrelas)
Métricas de merge de PR
 (Mesclagem média 11d 1h) (7 fundiu PRs em 30d)

Description

The documentation needs to be reviewed and cleaned up. Feel free to take on smaller tasks and open new Issues to track them.

Some things that need improvement:

  • Auto-generated API documentation
  • Add a detailed User Guide
  • Enable make docs from the project's root directory, so we don't need to cd into docs/

Guia do colaborador

Direção de pesquisa
Revise a documentação Sphinx existente, identifique as lacunas na documentação de API gerada automaticamente e no guia do usuário, e implemente as melhorias sugeridas.
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.
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.
Claro
Prerequisites
None
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
75