这是 pydoctor 命令,可以使用我们的多个免费在线工作站之一在 OnWorks 免费托管服务提供商中运行,例如 Ubuntu Online、Fedora Online、Windows 在线模拟器或 MAC OS 在线模拟器
程序:
您的姓名
pydoctor - Python 的 API 文档生成器
概要
医生 [选项]
商品描述
Pydoctor 是一个 API 文档生成器,主要通过静态分析工作。
它的编写主要是为了 Twisted 项目的目的而替换 epydoc 作为
epydoc 对 zope.interface 有困难,但可以用于非 Zope Python 代码作为
井。
配置
-h, - 帮帮我
显示此帮助信息并退出
-c 配置文件, --配置=配置文件
使用此文件中的配置(任何命令行选项都会覆盖来自
文件)。
-p 输入选择, --输入-pickle=输入选择
从此pickle文件加载系统(默认:无,创建一个空白系统)。
-o 输出, --输出泡菜=输出pickle
将系统保存到这个pickle文件中(默认:none,系统不保存
默认)。
--额外系统=SYS:URL前缀
在这个系统中寻找对象。 指向这些对象的链接将具有 URLPREFIX
预先给他们。
--系统类=系统类
用于创建系统的类的带点名称。
- 项目名=项目名
项目名称出现在 html 中。
--项目网址=项目网址
项目 url,如果给定,将出现在 html 中。
--项目基目录=项目目录
项目基目录的绝对路径。 将计算源链接
基于这个值。
--测试
如果运行没有任何效果,请不要抱怨。
--pdb 像 py.test 的 --pdb.
--make-html
生成 html 输出。
- 服务器
在本地服务器上提供 HTML。
- 服务器端口=SERVER_PORT
端口为 - 服务器 使用。
--仅限本地
仅将服务器绑定到本地主机。
--面向路径=FACING_PATH
设置一个 VHostMonster,包含所有的混乱。
- 编辑 提供 HTML 时,允许编辑。
--不检查
在提供 HTML 并允许编辑时,不要先检查所有文档字符串。
--添加包=包目录
向系统添加一个包。 可以重复添加多个包。
--添加模块=模块
在系统中添加一个模块。 可以重复。
--前置包=预包装
假设所有的包都在这个包内。 可用于记录部分
包。
--解析别名
这会更新对从它们所在的模块导入的类的引用
导入到对它们定义位置的引用。
--缩写-特殊情况=缩写映射
这是一个逗号分隔的键=值对列表。 其中任何键对应一个
模块名称和值是所需的缩写。 这可以用来解决
与缩写冲突,其中您有两个或多个以
同一个字母。 示例:twistedcaldav=tcd。
--文档格式=文档格式
假定采用哪些 epydoc 支持的格式文档字符串。
--html-主题=HTML 主题
要为其生成 API 文档的对象的 fullName(默认值:所有内容)。
--html-摘要页面
仅生成摘要页面。
--html-write-function-pages html-write-function-pages
为每个函数和方法制作单独的 HTML 文件。 他们没有链接到
任何 pydoctor 生成的 HTML,但它们可用于第三方链接。
--html-输出=输出
将 HTML 文件保存到的目录(默认为 'apidocs')
--html 编写器=HTML编写器
要使用的 html 编写器类的虚线名称(默认为“pydoctor.nevowhtml.NevowWriter”,
需要安装 Divmod Nevow)。
--html-viewsource-base=HTML资源库
这应该是我们在 svn checkout 顶部的 trac 浏览器的路径
记录部分。
--html-使用排序表
使用 sorttable JS 库制作包、模块和类内容的表格
可排序
--html-使用-splitlinks
生成(不显眼的)JavaScript 以允许在一个中显示类方法
每个基类的表或在一张大表中。
--html-缩短列表
生成(不显眼的)JavaScript 以隐藏长列表中的一些条目
例如子类。
--实时检查
导入并检查模块。 XXX现在不工作
-v, --详细
吵一点。 可以重复以获得更多噪音。
-q, - 安静的
安静点。
- 汽车 Automagic 模式:分析当前工作目录下的所有模块和包
并运行允许检查和编辑文档字符串的本地服务器。
--详细的=阶段
在特定的世代阶段要更吵闹。
使用 onworks.net 服务在线使用 pydoctor