HiveMinds / HiveMinds/python-template
Allow adding additional documentation that is added to the auto-generated `.py` file documentation.
未關閉
- 主要語言
- 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.
```
貢獻指南
這個儲存庫沒有索引到貢獻指南
研究方向
從 docs/source/some_name.rst 中的文件範例以及所參照的模組 src/jsonmodipy/helper.py 開始。檢查目前如何包含產生的 Python 檔案文件,並驗證轉譯後的文件。完成的標準是網站上可以在 automodule 輸出旁顯示其他文字。
由索引模型根據 Issue 內容生成。
評估
- 技術堆疊
- python
- 領域
- documentation
- Issue 類型
- 文件
- 難度
- 3/5
- 預估耗時
- 1-2 天
- 活躍度
- 停滯
- 描述清晰度
- 基本清楚
- 新手友好度
- 45/100