Mkdoc插件来自动记录你的numpy docstring
Numkdoc的Python项目详细描述
NumKdoc公司
NumKdoc是一个Mkdoc插件，允许您通过简单的类调用，从Numpy样式的docstring自动生成文档。在
此项目未维护，解析未完成。它基于NumpyDoc解析器。在
快速入门
如果您想尝试这个插件，请按照以下步骤操作：
- 在
下载此回购并（最终）将其解压到一个文件夹中
在 - 在
在项目文件夹中，执行命令
在python setup.py develop要安装 本地计算机上的插件。在 - 在
转到mkdocs项目文件夹，编辑
mkdocs.yml文件 最后加上这几行：plugins:-numkdoc
在
就这样。
现在可以使用标记{{ module.ClassName }}调用类的解析，
Numkdoc将自动用类文档替换该标记。在
示例
例如，您可以编辑docs/api/core.md
在任何位置归档并插入标记，如下所示：
- 项目
标签：
欢迎加入QQ群-->： 979659372
