HiveMinds / HiveMinds/python-template
Allow adding additional documentation that is added to the auto-generated `.py` file documentation.
Open
- Dominant language
- Python
- Stars
- 0
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Description
### 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.
```
Contributor guide
No contributing guide indexed for this repository
Assessment
This issue has not been assessed yet.