pwr-Solaar/Solaar

Docs: Build developer docs from code

Open

#2.503 aberto em 27 de mai. de 2024

Ver no GitHub
 (2 comments) (0 reactions) (0 assignees)Python (383 forks)batch import
enhancementhelp wanted

Métricas do repositório

Stars
 (4.528 stars)
Métricas de merge de PR
 (Mesclagem média 1d 15h) (5 fundiu PRs em 30d)

Description

Some code pieces already contain docstrings, which should be automatically compiled to documentation and published with GitHub pages on a page Developer documentation.

The numpydoc format is the preferred style.

Guia do colaborador

Direção de pesquisa
Configure a geração automática de documentação a partir de docstrings usando o formato numpydoc e publique no GitHub Pages.
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.
Meio dia
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
PythonGit
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
75