Python 中是否有相当于 Ruby's Yard 的东西？

Question

我同时使用 Python 和 Ruby，而且我真的很喜欢 Ruby's Yard 文档服务器：

http://yardoc.org/，

我想知道Python世界里是否有类似的东西？“pydoc -p”确实很旧，丑陋，使用起来一点也不舒服，而且看起来Sphinx和Epydoc不支持服务器模式。

你知道有什么等价的吗？

谢谢

Answer 1

Python 包实际上并没有约定将文档放置在何处。包的主要文档可以使用一系列不同的工具构建，有时基于文档字符串，有时则不是。您看到的pydoc -p只是包内容和文档字符串，而不是主要文档。如果这就是您想要的，您也可以使用 Sphinx 来实现此目的。这是sphinx-server我刚刚编写的 shell 脚本：

#!/bin/sh
sphinx-apidoc -F -o "$2" "$1"
cd "$2"
make html
cd _build/html
python -mSimpleHTTPServer 2345

调用此方法时，将您想要获取其信息的包的包目录作为第一个参数，将构建新文档的目录作为第二个参数。然后，将浏览器指向http://localhost:2345/

（注意：您可能想从脚本中删除 Web 服务器调用。这更多是出于演示目的。假设使用的是 Python 2.x。）