读取代码并返回可用于生成文档的JSON描述。像狮身人面像汽车医生,但没有狮身人面像。
inspected的Python项目详细描述
inspect.
在记录用python编写的库或软件产品时,通常
一个自述文件是不够的,但是完整的sphinx是太多的工作或太过严格。
inspect是一个命令行工具,它将自动记录python的代码,但它将输出作为机器可读的json或人类可读的标记返回,因此,您可以完全控制如何呈现
文档。
--include…
--exclude…
raw::html
<;object>;
一些
示例:
::
fixtures/example.py—包含名称:fun,名称:b
仅包含bean上的文档化方法
(这两个相同)
检查fixtures/example.py bean—包含文档化的
检查fixtures/example.py—包含名称:bean,members.documented
``.``遍历层次结构,`:``是要对其进行
测试的值。(如果您不指定值,我们将测试是否存在。)
`,``将多个条件分隔在一起。
todo:
-改进文档
-单元测试过滤机制
-在描述json(如果有的话)中填写缺少的信息
-一个“intercalate”实用程序,在文件的“`%`
标记中运行shell命令,并用这些命令的标准输出
在记录用python编写的库或软件产品时,通常
一个自述文件是不够的,但是完整的sphinx是太多的工作或太过严格。
inspect是一个命令行工具,它将自动记录python的代码,但它将输出作为机器可读的json或人类可读的标记返回,因此,您可以完全控制如何呈现
文档。
--include…
--exclude…
raw::html
<;object>;
一些
示例:
::
fixtures/example.py—包含名称:fun,名称:b
仅包含bean上的文档化方法
(这两个相同)
检查fixtures/example.py bean—包含文档化的
检查fixtures/example.py—包含名称:bean,members.documented
``.``遍历层次结构,`:``是要对其进行
测试的值。(如果您不指定值,我们将测试是否存在。)
`,``将多个条件分隔在一起。
todo:
-改进文档
-单元测试过滤机制
-在描述json(如果有的话)中填写缺少的信息
-一个“intercalate”实用程序,在文件的“`%`
标记中运行shell命令,并用这些命令的标准输出