microsoft/vasim

TODO: setup documentation generation

Aberta

#5 aberto em 30 de ago. de 2024

Ver no GitHubGuia do colaborador
 (1 comentário) (0 reação) (0 responsável)Python (7 forks)auto 404
TODOdocumentationhelp wanted

Métricas do repositório

Stars
 (12 estrelas)
Métricas de merge de PR
 (Métricas PR pendentes)

Description

As we slowly add the documentation, we also should setup auto doc generation. The pipeline code is in place. This particular setup uses sphinx but there are many options we could chose from.

Guia do colaborador

Direção de pesquisa
Configure a geração de documentação com Sphinx: crie o diretório 'docs', adicione conf.py, index.rst e configure a implantação no GitHub Pages ou Read the Docs.
Pilha de tecnologia
python
Domain
developer experience
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.
Recente
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.
80