扩展sphinx autodoc，包括自动摘要
autodocsumm的Python项目详细描述
| docs | |
|---|---|
| tests | |
| package |
欢迎这个sphinx扩展为sphinx提供了一些有用的扩展 autodoc扩展名。那些是
- 它以autosummary扩展的样式创建目录 方法、类、函数和属性
- 因为您可以通过 autoclass_content配置值， 我们提供autodata_content配置值以包括 来自__call__方法的文档
- 可以排除特定对象的字符串表示形式如果你 使用not_document_data配置有一个大字典 价值。
有关详细信息，请参见Documentation on Readthedocs
要求
该包只需要安装Sphinx。它已经过测试 高于1.3的版本
快速启动
要激活autodocsumm扩展，必须在 conf.py：
extensions=['sphinx.ext.autodoc',...,'autodocsumm',]
完成后，可以使用autodoc的:autosummary:选项 在顶部生成表的指令，例如：
..automodule:: my.awesome.module :autosummary:
（可选）默认情况下，可以为所有autodoc激活autodocsumm 通过添加conf.py：
autodoc_default_options={'autosummary':True,}
欢迎加入QQ群-->： 979659372
