在自定义 Sphinx 域中，我想创建对不同域中另一个节点的引用。例如：

我example:directive::说我的“方法”baz返回一些 type foo.bar，这是一个 Python 类。所以我想将它与其他py:class:: foo.bar描述交叉引用。

example在我的自定义域中，我正在解析我的指令并构建元素，一切都很好，即使我的域中的交叉引用也可以通过子类化该sphinx.domains.Domain:resolve_xref方法来正常工作。我只是不确定如何以编程方式在我的handle_signature方法中插入一个节点，该节点稍后会解析为另一个域中的节点。我会以某种方式必须实例化 asphinx.domains.python.PyXRefRole吗？

HTML 中的预期结果将类似于：

我在 PyCharm 中有一个 Python 项目，我想从我的 Python 代码和文档字符串中自动生成 API 文档（以 HTML 的形式）。

根据此页面，有许多生成 Python API 文档的工具：

• 自动总结
• 自动文档
• 文档
• PyDoc
• 医生
• 多氧

该页面还指出以下工具“处理文档”：

• DocUtils
• 狮身人面像

PyCharm 文档说DocUtils和 Sphinx 可用于“生成格式化的 API 文档”。但是，这似乎是不正确的，因为它们的配置表明这些工具只处理*.rst文件，而不是*.py文件。

我的问题是：我可以使用 PyCharm 的 DocUtils 或 Sphinx 功能来生成 API 文档吗？

如果做不到这一点，我可以使用 PyCharm 的任何功能来做到这一点吗？

如果做不到这一点，是否有任何工具可以与 PyCharm 很好地集成？

我正在使用 PyInstaller 为使用 docutils.rst 的 Kivy 应用程序构建 Windows exe 可分发包。在 PyInstaller .spec 文件中设置 console = False 时，会报告病毒。当控制台 = True 时，一切运行顺利。在包中排除 docutils 时，根本没有报告病毒，但是我缺少特定的 docutils 功能。

不幸的是，PyInstaller 开发社区不想再解决这些问题，而是将您引导至病毒软件供应商......（参见：https ://github.com/pyinstaller/pyinstaller/issues?q=is%3Aissue+virus+是%3A已关闭）。当然，在为大型多元化企业社区开发应用程序时，这实际上是不可能的。

问题 1：有人知道如何在可执行文件中禁用控制台 python 控制台吗？

否则我应该找到另一个方向来构建一个包。例如： 如何将 python 脚本编译为二进制可执行文件

问题 2：对于基于以下内容的包，您认为最好的选择是什么：python + kivy + multiprocessing + docutils.rst parser ？

为了完整起见，我添加了我的实际 PyInstaller 规范文件：

- - 模式：蟒蛇 - -

在Docutils 文档树中，title节点可能出现在一个部分内，也可能出现在文档本身内。

对于我正在创建的特定 Docutils NodeVisitor，我需要能够区分当前title节点是文档的标题，还是位于文档中的几个部分之一：如果它实际上是整个文档的标题，我只想跳过这个标题并继续。

我本来希望能够在以下范围内做到这一点Visitor.visit_title：

但是，这不起作用：访问者在另一个section节点中遇到文档的顶级标题。正因为如此，上面的检查（正确）说的父节点title不是节点。document

我怎样才能知道，在 中NodeVisitor，title实际上是特殊文档标题？或者，我如何才能连接到 Docutils 以便title它实际上是在文档级别，以便更容易地将它与section标题区分开来？

如何使用 Sphinx/rst 成功地安全部分标记段落？

渲染时（见下文），标题看起来不错，但句子看起来像一个列表。(由于对使用和)字符的部分标记信息的严格要求，使用替换/替换指令不是可接受的解决方案。

渲染输出：

如何遍历 Sphinx 中文档的每个部分名称？

（docutils 的文档在哪里？除了Sphinx 应用程序 API之外，很难找到任何有用的东西；即使查看docutils/nodes.py 的源代码也无济于事。）

我正在 Sphinx 中编写自定义角色/指令，我需要插入一个节点，在该节点中我将文本字符串解释为 reStructuredText。有没有办法做到这一点？

我找到了这个来源http://agateau.com/2015/docutils-snippets，它说明了如何使用docutils.nodes类以编程方式构建文档树片段，例如

我想做的是

通过在 conf.py 中执行此操作：

我在重组文本中定义了下表：

当它在 html 中呈现时（使用Sphinx），“两个选项： ”文本被包裹在一个段落标签中。“ Bar 做了一些事情。 ”文本不会使用段落标签呈现。应用样式表时，这会导致单元格文本看起来不同：

有没有办法对这两种情况强制执行相同的行为？

有一种使用 docutils 将 .ipnb 文件转换为 .rst 的已知方法，但我们可以在 .ipnb、.py 中转换 .rst 文件吗？

请提供一个例子，如果可能的话。

在Django 文档中有关于如何记录模型、视图和其他文件以使其在 Django Admin 中轻松可用的简短信息。但它缺乏关于如何为基于类的视图执行此操作的信息。说我有简单的DetailView：

我写的是这样的：

但这不会显示为引用模型/模板的文档文本。我该怎么做？