我同时使用 Python 和 Ruby,我真的很喜欢 Ruby 的 Yard 文档服务器:
我想知道 Python 世界中是否有等价物?“pydoc -p”真的很旧,丑陋且使用起来不舒服,而且看起来Sphinx和Epydoc不支持服务器模式。
你知道任何等价物吗?
谢谢
我同时使用 Python 和 Ruby,我真的很喜欢 Ruby 的 Yard 文档服务器:
我想知道 Python 世界中是否有等价物?“pydoc -p”真的很旧,丑陋且使用起来不舒服,而且看起来Sphinx和Epydoc不支持服务器模式。
你知道任何等价物吗?
谢谢
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/
(注意:您可能希望从脚本中删除网络服务器调用。这更多是为了演示。这是假设 Python 2.x。)
似乎没有必要仅仅为了提供一些 HTML 而实现 Web 服务器。我倾向于喜欢每个工具做一件小事的 *ix 哲学,嗯。并不是说 Web 服务器很小。