pybind / pybind/python_example
Building the docs
Aberta
Ninguém assumiu esta issue ainda.
- Linguagem predominante
- Python
- Estrelas
- 530
- Forks
- 150
- Merge médio
- 8d 2h
- PRs com merge (30d)
- 1
Descrição
Hi,
I can build the docs with Sphinx using make html but when I open the html files I can't see any of the function docstrings. I'm new to Sphinx so I might be missing something.
Guia de contribuição
Nenhum guia de contribuição indexado para este repositório
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Direção de pesquisa
Comece executando o build documentado do Sphinx com make html e inspecione o HTML gerado junto com a configuração do Sphinx. Determine por que as docstrings das funções Python não estão incluídas; considera-se concluído quando a documentação gerada exibir essas docstrings.
Escrita pelo modelo de indexação a partir do texto da issue.
Avaliação
- Stack de tecnologia
- python
- Domínio
- documentation
- Tipo de issue
- Bug
- Dificuldade
- 3/5
- Tempo estimado
- 1-2 dias
- Status de atividade
- Estagnada
- Clareza
- Precisa de esclarecimento
- Facilidade para iniciantes
- 35/100