HiveMinds / HiveMinds/python-template

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

未关闭
#2 0 条评论 0 个 reaction 已指派 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 摘要。