问题标签 [autodoc]

我刚刚开始使用狮身人面像并愿意学习。

我想将我的各种功能分解为index.rst文件中的不同部分。所以每个函数都有自己的标题。

因此，例如，如果我有一个名为的 python 文件test.py，并且在该文件中我有 2 个函数：

我怎么能index.rst在我的 test.py 文件中分开这两个函数？

如果我能弄清楚如何分离这些功能，让它看起来更干净index.html，那就太好了！现在，如果我只运行以下命令，输出不是很干净：

我想为一个名为 Ulyxes PyAPI 的 API 制作文档。我已经启动了它，但是自动生成过程不起作用。当我在我的 index.html 页面中单击自动生成的文档链接时，我被称为一个没有关于我的类和类函数的信息的空页面
实际上，我的 API 中有一个 10 多个 python 文件，每个文件都包含一个类模型测量传感器（机器人全站仪、GPS 等）。在这个问题中，我只写了一小部分，以使我的问题易于理解。

我认为，无论是 code.rst 还是 leicameasureunit.py 都是错误的......

*.py 和 *.srt 文件位于我的工作目录相同的目录中。我使用的是windows 7操作系统。

非常感谢！

...\UlyxesPyApiDoc：

文件如下：

索引.srt：

代码.rst：

项目.srt：

教程.srt：

leicameasureunit.py：`

`

我正在尝试使用 sphinx 来记录我正在编写的django应用程序。到目前为止，我有我的code.rst设置来查看models.py，当我运行时，make html我得到了自动文档，但是我得到了一个警告：

警告：autodoc 无法导入/查找属性“myapp.models.MyModel.image”，它报告错误：“image”，请检查您的拼写和 sys.path

整个跟踪日志是：

MyModel.image是一个图像场，简单地在模型上定义为：

如果我将图像更改models.Charfield为例如它运行良好。有什么原因ImageField会导致狮身人面像问题吗？

我的代码.rst：

尽管阅读了本教程、这个问题和numpy 文档字符串标准，但我无法让 sphinx autodoc 与 numpy 文档字符串很好地配合使用。

在我的conf.py我有：

在我的文档文件中，我有：

哪里python_file.py有：

当我跑步时，make html我得到ERROR: Unknown directive type "autosummary". 当我添加autosummary到我的extensions因此：

我得到：

按照这个问题的建议，我添加numpydoc_show_class_members = False到我的conf.py.

现在我可以正常运行make html了，但是ParametersandReturns部分不会被解释为 numpydoc 部分。

有没有办法摆脱这种混乱？

我目前正在使用 Sphinxhttpdomain扩展记录 HTTP API。我在每个请求端点上都有一个文档字符串，用于记录参数、查询参数、返回值和异常。我希望在 Sphinx 文档中使用这个文档字符串。

目前我使用了 automethod 指令，如：

这将格式化文档字符串，包括使用httpdomain.

我基本上希望它跳过第一行。我在 SO 上发现了另一个与此类似的问题，它提供了抑制所有方法签名的解决方案。但是，此文档是一个更大项目的一部分，我希望autodoc为所有其他自动生成的文档保留功能。

在我的代码中，我有

然后

因此，在我的 Sphinx 文档中，使用（例如，使用.. autofunction::等）我X_DEFAULT在签名中得到了扩展的整个长而笨重的值some_function：

some_function ( ..., x=['a', 'long', 'list', 'of', 'values', 'that', 'is', 'really', 'ugly', 'to', '看到'，'结束'，'和'，'结束'，'再次'，'每个'，'时间'，'它'，'是'，'推荐'，'to'，'in'，'the' , '文档'], ... )

有没有办法在生成的文档中抑制这种替换，最好是通过链接回到以下定义X_DEFAULT：

some_function ( ..., x= X_DEFAULT , ... )

我知道我可以手动覆盖我明确列出为 Sphinx 文档指令参数的每个函数和方法的签名，但这不是我的目标。我也知道我可以使用autodoc_docstring_signature文档字符串的第一行，但这会产生错误的文档字符串，真正用于自省失败的情况（如 C）。我怀疑我可以做的事情autodoc-process-signature可能是足够的（但不是完美的），但我不确定如何进行。

如何使用一个只有功能的 .py 文件制作 Sphinx 文档？

我有一个 .py 文件，其中包含多个函数，其中已经包含文档字符串，但不想:function:: console.someFunction为所有函数创建一个。是否有更智能或更好的方法来遍历所有功能？

我想确保在有人将某些内容提交到 SVN 存储库之前，对 Java 类进行了注释。所以我想实现以下工作流程：

1. 用户更改类中的某些内容
2. 用户想要提交课程
3. 在执行对存储库的提交之前，SVN 或其他东西会检查类之前和public方法之前是否有注释（对于 Java AutoDoc）。
4. 如果有评论 => 提交，否则返回错误信息

我怎么能意识到这一点？我发现了很多关于预提交钩子的信息。但一切都是为了检查是否设置了提交消息/评论。

如果有人可以为这个问题提供解决方案，那将是非常好的和有帮助的。

我正在开发的项目包含一个包，其中包含不同语言的 API：Java、Python、C# 等。所有这些 API 大多共享相同的文档。文档应在我们的网站上分别以 PDF 和 HTML 格式提供。用户通常会下载/浏览其感兴趣的内容。

目前我们使用 sdocml，但我们并不满意，因此我们希望使用更新的工具，我们正在考虑使用 Sphinx。

查看 Sphinx 文档，我无法清楚地弄清楚如何：

1-说为某个API（例如Java）生成文档

2- autodoc 是否适用于任何域？

3-有ac#扩展吗？

任何帮助都是最受欢迎的！

我想在 sphinx 文档中自动包含函数的子函数。有什么选择？

我的代码看起来像

现在我设置在包含的code.rst

但是 sphinx 的输出只包含 main 函数。