从文档中筛选参数的sphinx扩展
sphinxcontrib-autodoc-filterparams的Python项目详细描述
虽然这通常是糟糕的架构的症状，但有时 确实想从sphinx文档中排除函数参数。
这个分机就是这么做的。
用法
- 将其添加到conf.py扩展列表中，通常在
sphinx.ext.autodoc的条目。 如果使用napoleon扩展名来重新格式化 docstrings，然后立即添加它。 - 声明一个名为
sphinxcontrib_autodoc_filterparams的函数。
示例
下面将隐藏名称以下划线开头的所有参数：
extensions=['sphinx.ext.autodoc','sphinxcontrib_autodoc_filterparams']defsphinxcontrib_autodoc_filterparams(fun,param):returnnotparam.startswith('_')
回调包含两个参数，当前函数和参数 应返回一个布尔值，指示是否保留参数。
一个稍微详细一点的示例将查看函数上下文以及 参数名称：
exclude_params={'my_package.my_module.MyClass.my_method':{'**kwargs'}}defsphinxcontrib_autodoc_filterparams(fun,param):exclude=exclude_params.get(fun.__module__+'.'+fun.__qualname__)returnexcludeisNoneorparamnotinexclude
选项
sphinxcontrib_autodoc_filterparams
为每个函数参数调用的回调函数。如果这个函数
返回True然后记录参数，否则
被排除在外。
sphinxcontrib_autodoc_filterparams_stars
一个布尔值，指示参数前是否应加上星号
调用回调时的名称（一个星表示可变位置，两个星表示
对于变量关键字）。默认值是True。
欢迎加入QQ群-->： 979659372
