通过预处理器将sphinx类docstring规范的处理添加到pdoc。
pdoc-prep的Python项目详细描述
pdoc_prep:将sphinx类函数doc specs添加到pdoc中
准备使用sphinx类参数的python文件,并返回规范以输入pdoc文档工具(https://pypi.org/project/pdoc/)。
动机:
pdoc html输出无法识别函数/方法参数,并且无法将文档字符串中的返回规范视为特殊的。所以,
:param foo: controls whether bar is set to None
:type foo: int
:return True for success, else False
:rtype bool
会出现在字面上。如果要记录的模块使用此脚本进行预处理,则pdoc文档将如下所示:
foo (int): controls whether bar is set to None
returns True for success, else False
return type: bool
关键字,如返回,参数,如foo(int)将是粗体的。
注意:是使用“:”引入规范,还是通过命令行选项控制“@”。见下面的主要章节。
用法
shell> pdoc_run.py --html-dir docs src/pdoc_prep/pdoc_prep.py
此命令可以从项目根目录、evolutional docs目录或package目录中运行。显然,路径需要相应地调整。
注释
注1: 您可能会看到:
DeprecationWarning: the imp module is deprecated in favour of importlib; see the module's documentation for alternative uses
import imp
此警告出现在pdoc中,此预处理器未对其进行修改。要抑制警告,可以定义环境变量:
export PYTHONWARNINGS=ignore
在你工作的地方。
注2: 将此功能包含在pdoc html生产代码中更为明智。唉,时间不够。