通过预处理器将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生产代码中更为明智。唉,时间不够。

欢迎加入QQ群-->: 979659372 Python中文网_新手群

推荐PyPI第三方库


热门话题
java Android HttpClient cookies   如何使用Java在远程系统上运行SSH命令?   java从字符串数组中的字符串末尾删除“,”   在One plus 3t手机上,当应用程序被终止或从最近的应用程序中刷出时,java Android FCM推送通知不起作用   java如何使垂直滚动条始终位于jtable的末尾   在java中解析迄今为止“未知”的字符串   javascript在Java中获取Nashorn JsonObject   java windows 10和ubuntu可以使用相同的JDK吗?   java在不同的文件中记录不同的日志。但所有日志都放在同一个文件中   具有特定jdk的java Gradle构建项目   xml Java web服务生成错误响应   javascript Jaggery文件更改不显示   java输出二进制搜索树数组   将BufferedReader解析为JSON对象时,java在位置处意外标记文件结尾