问题标签 [autodoc]

我有这样的课：

和另一个继承它的类：

当我使用 sphinx 的 autodoc 生成文档时，MyObj.x没有记录。有什么方法可以继承文档字符串MyBase.x吗？我找到了 DocInherit，但由于它使用装饰器，它只适用于类方法。有什么办法可以用属性做到这一点？

默认情况下，Sphinx 不会为 __init__(self) 生成文档。我尝试了以下方法：

和

在 conf.py 中，设置以下内容仅将 __init__(self) 文档字符串附加到类文档字符串（Sphinx 自动文档文档似乎同意这是预期的行为，但没有提及我要解决的问题）：

我用 Python 3 编写了一个程序，并正在使用 Sphinx 来记录它。Sphinx 的 autodoc 很棒，但它只适用于 Python 2。一些模块在 autodoc 中可以正常工作，但模块不能。一些例子：Python 2 抱怨 Python 3 风格的元类，以及一些在 Python 2 中不再存在的模块，例如configparser。这很烦人，因为它无法从该文件导入文档字符串。

我不想用 Python 2 重写整个程序，但是我想使用 autodoc。

我的一个想法是一个小程序，它读取每个 Python 文件并删除所有功能，但只留下基本函数和类及其文档字符串（因为 autodoc 导入每个模块并读取特定函数或类的文档字符串）。

进入...

通过这种方式，自动文档可以读取处理后的代码，但仍然具有我真正需要的文档字符串。这是解决这个问题的最佳方法吗？有人对如何编写转换代码的小程序有任何建议吗？

我可以用一些正则表达式很容易地消除元类问题，但我正在努力解决剩下的问题。

ast模块有用吗？

谢谢。

我使用 sphinx 自动生成文档。当我运行“make html”时，它引发了以下错误。

我在http://jaredforsyth.com/blog/2010/apr/28/accessinit-hash-collision-3-both-1-and-1/中找到了相关文章。它说这是导致冲突的导入PIL的不同方式。我完全按照这篇文章说的做，修补 Docutils 和 Pygments，但我仍然得到上述错误。

谁能告诉我如何解决这个问题？

在使用 Leiningen 时，我收到以下突然错误：

线程“主”java.lang.NoSuchMethodError 中的异常：org.apache.tools.ant.util.FileUtils.getFileUtils()Lorg/apache/tools/ant/util/FileUtils; (core.clj:1)

我在https://github.com/technomancy/leiningen/issues/194找到了以下答案：

我在https://github.com/technomancy/leiningen/blob/master/doc/TUTORIAL.md阅读了 Leiningen 教程，在https://github.com/technomancy/leiningen/blob/stable阅读了示例 project.clj 文件/sample.project.clj，但我仍然有以下问题：

1) 在上面标记为1的行，我不知道如何排除特定版本的 jar 文件。

2) 在上面的2处，究竟是什么bin/lein？我的 Leiningen 项目没有 bin 目录，而 Leiningen 本身就是一个脚本，所以那里没有 bin 目录？

非常感谢您的帮助。

附录 8/6/11：对于 Autodoc 的具体问题，我找到了 Autodoc 的一个分支，它为我解决了这个问题。只需将 "[org.clojars.weavejester/autodoc "0.9.0"]" 添加到 project.clj > defproject >:dev-dependencies子句。然后，从命令行（目录等于您的 leiningen 项目的根目录），执行“lein autodoc”，然后等待一段时间。

我正在尝试在 Sphinx 中为我的项目编写文档，每当 Sphinx 在我的模块中遇到 OptionParser 时，它都会给我：

sphinx-build：错误：没有这样的选项：-b

我认为这是不可能的，所以我写了一个简单的模块来检查这个：

它给了我同样的错误。我的第一个看起来像这样：

我正在寻找使用“WCF REST 服务模板 40”创建的 REST 服务的文档工具并遇到 Autodocs (http://autodocs.codeplex.com/)，但是我不确定它们是否会一起工作……

任何使它工作的人或对另一个用于文档的工具的任何建议（重要的是它是记录的 REST 服务，而不是 C# API）

TIA

索伦

我正在使用 Sphinx 的自动文档功能来记录我的 API。

例子：

生成的文档现在显示以下签名：

我如何告诉 Sphinx 保留常量值的名称，即

?

有没有我忽略的选项？如果可能的话，我不想再手写所有签名。

我有一个 Google App Engine 项目，我正在尝试用 Sphinx 记录它。我正在尝试对我的许多模块/类/功能使用自动文档功能。

我的 Sphinx reST 标记：

当我运行时make html，我收到错误：

该文件urls导入webapp2，我相信它会反过来尝试导入 appengine.api。我认为它不可能提供appengine.api给我的sys.path. 有一些解决方法吗？

PS。我没有和斯芬克斯结婚。我愿意接受 epydoc 或替代方案。

我使用 Doxygen 工具生成文档。但后来我才知道苹果自己提供了“文档集指南”。

这是参考链接：http: //developer.apple.com/library/mac/#documentation/DeveloperTools/Conceptual/Documentation_Sets/000-Introduction/introduction.html#//apple_ref/doc/uid/TP40005266-CH1-SW1

有没有人知道这一点 - 如何使用这个和所有？它对自动生成的文档创建是否有用？

提前致谢，

穆纳尔