Hacktoberfest 2026: as issues que os mantenedores marcaram para outubro, abertas e boas para iniciantes. Ver issues do Hacktoberfest

Publish documentation using Sphinx

Aberta
  • Algo errado?
#39 0 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
4/5
Tempo estimado
3-5 dias
Facilidade para iniciantes
25/100
Tipo de issue
Documentação
Clareza
Precisa de esclarecimento
Status de atividade
Estagnada
Stack de tecnologia
python
Domínio
documentation

Direção de pesquisa

A issue menciona Sphinx e aponta para um guia de documentação do Python, mas não contém arquivos do repositório, testes nem pontos de entrada da documentação. Revise primeiro a estrutura de documentação existente e o guia vinculado; considera-se concluído quando a documentação do projeto estiver configurada e publicada usando Sphinx.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

enhancement help wanted

While looking at #33 that seemed like the simplest approach / lowest hanging fruit and exciting to publish docs with, the better documentation publishing for Python is Sphinx.

Let's therefore use Sphinx instead following this - http://docs.python-guide.org/en/latest/writing/documentation/

Linguagem predominante
Python
Estrelas
19
Forks
20
Nenhum PR com merge em 30d

Preparar o ambiente

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de CodeForAfrica/HealthTools.API

Todas as issues de CodeForAfrica/HealthTools.API

Issues semelhantes

Mais issues de Python

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.