python-sphinx 相关问题

Sphinx是一种工具，可以轻松创建智能和漂亮的文档。 Sphinx特别适用于Python文档，但它是一个通用工具，可用于记录任何内容。

使用 Sphinx 和 rinohtype 生成 PDF 文件时显示章节标题而不是章节编号

我指定了一个显式链接目标，如下所示： .._REPLY_STATUS_CODE： REPLY_STATUS_CODE (0x0001) ---------------------------- 然后创建对它的引用，如下所示：有关的 :ref:`回复状态...

python-sphinx restructuredtext rinohtype

回答 1 投票 0

链接到 Python 文档字符串中的类方法

我想从同一类的另一个方法的文档字符串中添加指向我的类中的方法的链接。我希望该链接能够在 Sphinx 中工作，并且优先在 Spyder 和其他 Python IDE 中工作...

python spyder python-sphinx cross-reference

回答 3 投票 0

如何在没有 CDN 的情况下将 MathJax 包含在本地 Sphinx 构建中？

我试图将 MathJax 包含在我的本地 _static Sphinx 目录中，以避免在本地开发时在重建时下载它的开销。我按照说明进行操作并将 mathjax_path 设置为 ...

python-sphinx mathjax

回答 1 投票 0

如何在 reStructuredText (sphinx) 中嵌入 HTML 或 XML 以便浏览器可以渲染它们？

我只需要在reStructuredText（sphinx）中嵌入一小段html或xml，以便浏览器可以在生成的HTML文件中渲染它们，就像下面的小段一样 .. 原始:: html ...

python-sphinx restructuredtext

回答 1 投票 0

如何在 Sphinx 中的单行上内联编写多个数学方程

我想在我的Sphinx reST文档中编写如下简单的一行：要使用 :math: 标志编写该行：我们知道 :math:`A o B dash A o orall x B`，前提是 :math:`x` 在 :

html css python-sphinx restructuredtext

回答 1 投票 0

使用sphinx生成python文档时如何保留换行符

我正在使用 Sphinx 为 python 项目生成文档。输出 html 不保留文档字符串中存在的换行符。例子：代码 def testMethod(arg1,arg2): ”“” ...

python python-sphinx

回答 10 投票 0

reStructuredText 替换

我正在尝试对 Sphinx 中的 csv-table 指令加载的文件进行替换。我的想法是做这样的事情： .. csv-table:: 我的 CSV 表 :header: "第 1 列", "Co...

csv python-sphinx substitution restructuredtext

回答 2 投票 0

表格根据原始内容自动调整列宽，无论指令如何

假设您使用 Sphinx 2.x 编写一个文档并在其中创建一个表。将指令放入某些表格单元格中，如下所示：没有指令（好） +--------+---------------------------------------- ------...

python-sphinx substitution restructuredtext

回答 2 投票 0

Sphinx 别名支持（替换？）

我正在考虑将我的文档从 Doxygen 转移到 Sphinx 并寻找 Doxygen 别名的替代方案。在 Doxygen 中，我有一个别名，可以将表格等复杂命令替换为更真实的命令...

python-sphinx substitution restructuredtext sections

回答 2 投票 0

Sphinx 警告：“重复的替换定义名称” - 错误在哪里？

当我构建 Sphinx 项目时，我遇到了一系列类似这样的错误 - 三次： content/swdocs.rsts:6：警告：重复的替换定义名称：“复制”。 sdwocs.rsts 包含

python-sphinx restructuredtext

回答 1 投票 0

如何在Sphinx reST中写入该行？

我想在我的Sphinx reST文档中编写如下简单的一行：要使用 :math: 标志编写该行：我们知道 :math:`A o B dash A o orall x B`，前提是 :math:`x` 在 :

html css python-sphinx restructuredtext

回答 1 投票 0

是否可以使用 sphinx-apidoc 在同一 git 存储库中为多个包创建文档？

我有一个 git 存储库，其中包含多个遵循命名空间的包（即 PEP 420. 我正在尝试使用 Sphinx 创建 ReadTheDocs 文档。 git 存储库看起来像这样...

python python-sphinx read-the-docs namespace-package sphinx-apidoc

回答 1 投票 0

如何使用Sphinx生成Microsoft Word文档

Sphinx 支持几种输出格式：多个 HTML 文件（带有 html 或 dirhtml） Latex 对于创建 .pdf 或 .ps 非常有用文本如何获取 Microsoft Word 文件中的输出？与

ms-word python-sphinx documentation-generation

回答 8 投票 0

在 Sphinx 中，如何生成包含域中所有项目信息的页面？

我在Sphinx中编写了一个自定义域。它具有注册项（最终都在数据成员中）的指令，然后并行构建与 merge_domaindata 合并在一起。我想创建一个

python documentation python-sphinx docutils

回答 1 投票 0

将执行的 Jupyter Notebook 嵌入到基于 rst 的文档中

我想将 Jupyter 笔记本嵌入到 RST 文件中。最好，这个笔记本可以是交互式的，但至少可以看到。如果这些笔记本可以在

jupyter-notebook python-sphinx restructuredtext

回答 1 投票 0

解决在Sphinx扩展中查询`self.state.document.current_source`时出现docutils错误，或者更好的获取文件路径的方法

考虑通用指令作为新扩展的基础。我只会显示引发错误的代码。导入 docutils.nodes 从 docutils 导入节点，核心导入 docutils.nodes 来自文档...

python python-sphinx docutils

回答 1 投票 0

我可以直接将 docutils 节点作为 XML 文件加载吗？

docutils 文档基于节点层次结构。他们自始至终都说节点是 XML（或者至少是类 XML），并且有多种方法可以将文档和文档片段转储为 XML 格式。他们

python xml python-sphinx docutils

回答 1 投票 0

使用 Sphinx 记录用户创建的类型声明

我正在做一个类型声明。例如：从输入导入元组类型1 = 元组[str, float] 我希望 Sphinx 像函数声明一样记录此声明。我该怎么做？比...

python-sphinx

回答 1 投票 0

在 Visual Studio Code 中，如何重命名 Python 中的变量并更新其在 ReST 格式文档中的出现？

假设我有：班级您好： """示例类。""" 世界：str """这是 :py:class:`Hello` 上唯一的字段。""" 有记录

python visual-studio-code python-sphinx restructuredtext

回答 1 投票 0

ReadTheDocs Sphinx：警告：字段列表结束时没有空行；意外的未缩进

我正在使用 Sphinx 记录我的 Python 包。但我遇到了一些警告，我不知道该怎么办。所有这些都发生在我的模块级文档字符串中，而不是在类中......

python python-sphinx read-the-docs autodoc sphinx-napoleon

回答 1 投票 0

python-sphinx 相关问题

最新问题