HiveMinds / HiveMinds/python-template
Allow adding additional documentation that is added to the auto-generated `.py` file documentation.
- Vorherrschende Sprache
- Python
- Sterne
- 0
- Forks
- 1
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
### 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.
```
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Rechercherichtung
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.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 45/100