Python中是否有Ruby的Yard等价物？

我同时使用Python和Ruby，我真的很喜欢Ruby的院子文档服务器：Python中是否有Ruby的Yard等价物？

我想知道如果在Python世界中的相同呢？ “pydoc -p”真的很旧，很丑并且根本不舒服，它看起来并不像Sphinx和Epydoc支持服务器模式。

你知道有什么等价物吗？

谢谢

2012-04-25 Kedare

我不知道院子。你能解释一下Yard做了什么，特别是你可以从Python中得到什么样的功能？ – 2012-04-25 20:13:27

Yard是一个文档服务器，它在安装时会自动生成gems（等同于鸡蛋）文档，也可以用作独立文档生成器（如sphinx），它提供了一个非常好的现代Web界面，包括搜索，语法着色和类/模块树，你可以在这里看到一个在线文档的例子：http://rubydoc.info/docs/yard/frames/file/docs/WhatsNew.md – Kedare 2012-04-25 20:15:54

我正在寻找的功能是文档服务器这比pydoc -p更方便使用，这将允许我在文档中进行搜索并且可以轻松导航到文档中（例如Yard树） – Kedare 2012-04-25 20:18:14

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服务器调用它更多的demonstrattion的目的，这是假设的Python 2.x版本。）

来源

2012-04-25 20:54:39

我在一个随机项目SQLAlchemy），我只有一个没有任何文档的模块列表，这是正常的吗？ – Kedare 2012-04-25 21:01:15

@Kedare：我也尝试过一个随机包（来自标准库的'logging'），它对我很有用。应该以可以通过Python导入的方式安装该软件包，并且您应该将Sphinx指向可从其导入软件包的目录。狮身人面像只能自动构建它可以导入的模块的文档。 – 2012-04-25 21:03:56

好的，这是一个案件的问题，我再次用包名称上的好例子，它工作:) – Kedare 2012-04-25 21:09:34

似乎不需要实现一个Web服务器来提供一些HTML。我倾向于喜欢每个工具的* ix哲学来完成一件小事。并不是说Web服务器很小。

但你可以看看http://docs.python.org/library/basehttpserver.html

来源

2012-04-25 20:49:48 user1277476

Python中是否有Ruby的Yard等价物？

回答

相关问题