问题标签 [sphinx-apidoc]

我正在尝试使用 django 项目的 Sphinx 生成 html 文档。make html在 windows cmd 上执行时出现以下错误。Mysettings.py包含我构建的应用程序的条目，该 models.py文件所属的位置。出于保密原因，我在这里将其称为 project_name。

错误跟踪：

谢谢你的帮助！

我的目录如下（__init__.py此处未列出正确的文件）：

跑步sphinx-apidoc . --full -o docs -H 'MyProject' -A 'MyName' -V '1.0'我几乎得到了我需要的一切：

• index.rst
• package1.rst
• package1.subpackage1.rst
• package2.rst

index列出package1但package2 不 package1列出package1.subpackage1。

我不想手动编辑package1.rst，因为大型项目手动列出每个子包是不可扩展的。

我目前正在尝试使用 Sphinx 实现自动文档创建（使用扩展 sphinx-apidoc 和拿破仑）。这工作得很好，但如果类型提示（PEP484 约定）自动添加到参数列表中会更好。

我想知道这是否可能。

更具体地说：（来自拿破仑的例子）

这呈现如下：

参数列表包含所有参数，但不附加类型。可以手动添加它们，但这可能会在决定更改签名时引入未来的问题。

手动类型添加示例：

呈现为：

我正在尝试使用 Sphinx 自动生成项目的文档。我的项目看起来像：

我已经为后端生成了自动文档，但是在尝试为我的项目/项目/前端/src 中的 javascript 文件执行此操作时遇到了困难。我想使用 sphinx-js，但是命令

仍然只为 *.rst 的 python 文件生成文档。

我已经安装了 sphinx-js：

并将这段代码放在 conf.py 中：

我已经更新了扩展：

文档仅包含 .py 文件，但现在它也可以在 frontend/src 中看到它们（我检查过）。

我做错了什么？

背景

我的代码具有以下结构：

在sphinx-quickstart(with autodoc) 之后，我运行sphinx-apidoc如下：

我现在有以下文件：

我还修改conf.py添加：

并添加modules到index.rst：

现在问题来了

运行后make clean ; make html我收到警告：

这是有道理的，因为sphinx-apidoc 没有在my_package.rst. 我该如何解决这个问题？

我正在使用 Sphinx 的 apidoc 扩展来为 Python 项目生成文档。这比我预期的要古怪，但我已经完成了大部分工作。然而，一个怪癖让我难住了。

我有几个带有文档字符串的类，其中包括以下内容：

Sphinx 会自动添加一个从“doppleganger”到它共享名称的类的链接——我找不到阻止它的方法。在一般情况下，我只会更改其中一个名称，但不幸的是，这两个名称均来自我无法更改的 XSD 规范自动生成的代码。

有什么简单的方法可以阻止这些链接被插入？

我有 python 类，其中一些在他们自己的文件中

即userdata.py：

我尝试了多种方法来引用文档中该类中的特定方法，但它不起作用。

我正在通过命令生成自动文档

它只为上面的代码生成模块

具有多个类的模块的类似问题，即 ad1.py

自动文档：

有没有办法自动生成自动类和自动方法。

在使用sphinx-apidoc生成 RST 文件时，我无法正确添加我的 __main__.py 文件及其功能。其他文件和类已正确生成。

只有当我使用-P包含私有模块的参数运行 sphinx-apidoc 时，我才能工作。但我不想添加其他模块的私有方法，我只需要 __main__.py 中的这些。

__main__.py 看起来像这样：

我想拥有main(),f1()并f2()包含在 sphinx-apidoc 生成的 RST 文件中。

有一个类似的问题Documenting python script entry (__name__ == '__main__') using sphinx但它没有回答我的问题。

我对 Sphinx 完全陌生，已经观看了数小时的教程，但找不到我的问题的答案

我有一个当前的项目结构，如下所示

我在我的 conf.py 中包含了以下内容

在每个子文件夹中，我都有 .py 文件，其中包含所有需要记录的类、函数、模块和成员。有没有办法让 sphinx 解析当前项目文件夹及其所有子目录以搜索 .py 文件到 autodoc？如果是这样，我将如何设置我的 index.rst 和 conf.py 文件来实现这一点？

我看到的错误如下：

在mypkg/_core.py我有

在__init__.py我有

我认为有一个默认配置可以避免记录导入的所有内容，这很好。就我而言，_core.py是一个私有模块，我不想记录它。我希望将该文档导出到顶级mypkg模块文档。

我想出SomeClass现在顶级mypkg文档中，但它没有。