HiveMinds / HiveMinds/python-template

Allow adding additional documentation that is added to the auto-generated `.py` file documentation.

オープン
#2 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る
主要言語
Python
スター
0
フォーク
1
PR マージ指標
30日以内にマージされた PR はありません

説明

### 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.
```

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

評価

この issue はまだ評価されていません。

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。