HiveMinds / HiveMinds/python-template
Allow adding additional documentation that is added to the auto-generated `.py` file documentation.
- Linguagem predominante
- Python
- Estrelas
- 0
- Forks
- 1
- Métricas de merge de PRs
- Nenhum PR com merge em 30d
Descrição
### Include .py file example
To add a file in `src/jsonmodipy/helper.py` you
create a `docs/source/some_name.rst` file with content:
```rst
.. _helper-module:
Helper Module
===============
.. automodule:: jsonmodipy.helper
:members:
:undoc-members:
:show-inheritance:
And here you can just type additional text that will be displayed on the site.
```
Guia de contribuição
Nenhum guia de contribuição indexado para este repositório
Direção de pesquisa
Start with the documentation example in docs/source/some_name.rst and the referenced module src/jsonmodipy/helper.py. Check how the generated Python-file documentation is currently included and verify the rendered documentation. Done means additional text can appear alongside the automodule output on the site.
Escrita pelo modelo de indexação a partir do texto da issue.
Avaliação
- Stack de tecnologia
- python
- Domínio
- documentation
- Tipo de issue
- Documentação
- Dificuldade
- 3/5
- Tempo estimado
- 1-2 dias
- Status de atividade
- Estagnada
- Clareza
- Razoavelmente clara
- Facilidade para iniciantes
- 45/100