问题标签 [docutils]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票
1 回答
315 浏览

multilingual - 单个 reStructuredtext 文件中的多个翻译

有没有办法实现以下目标?

  • .rst源文件是多语言翻译并存的单个文件
  • 生成每种语言的网页演绎版(.html最好在文件中)。
    • 这可以是读者可以在不同语言之间切换的单个文件,也可以是多个单独的 .html 文件
  • rst2html最好可以通过其他常用工具来完成网页生成

我想到的用例。在foo.rst(我并不是说我想要这样的标签):

正如我提到的,结果将是单个foo.html或一组foo_en.htmland foo_de.html

0 投票
1 回答
506 浏览

python - 扩展第一个容器以输出额外的 div 属性

我开始使用具有 reStructuredTextrst页面格式的 pelican。我有自定义 javascript (jQuery) 的东西,我想用 div 属性来控制,比如data-default-tpl="basename"嵌套内容。

扩展什么,扩展什么。我看过Directivesand nodes,但我就是不知道该怎么做。

鹈鹕从 rst 到 html。

0 投票
0 回答
879 浏览

python - sphinx:通过 raw::latex 包含 .eps 图像

我想在 sphinx 中添加一个 eps 图像,使用 raw::latex 命令。我想象这样的事情:

运行 sphinx-build 命令可以完美运行,但奇怪的是 ..raw:: latex 块中的所有内容在 html 文件中都被忽略了。我错过了什么?

我是否需要在 docutils.conf 文件中启用原始命令?我在 /etc 中找不到该文件。

0 投票
1 回答
445 浏览

python - 如何在 sphinx 中创建上面部分的可引用标签节点

我正在 sphinx 中创建一个自定义指令。该指令列出了所有可能的对象(每个都在单独的部分中)。

现在我希望这些对象可以从文档的其他部分(文件)中引用。

我试图做一些非常简单的事情,比如:

但它不允许我通过 :ref: object-unique-id1、 :ref:object-unique-id2和 :ref:来引用本节abc

所以我的问题是:如何创建可以引用的节点?

0 投票
1 回答
1688 浏览

python - 如何使用 docutils 将 .rsts 转换为 htmls?

我下载了一个util(cmake,实际上)tar,它的doc被写成.rst文件,结构像blow。谷歌搜索后,我知道docutils(一个python包)可以将这些文件转换为html,所以安装了它,但我可以找不到办法吗?请告诉我,有什么简单的命令可以做到吗?怎么做?

//doc文件结构(ubuntu下ls -l生成)

0 投票
1 回答
134 浏览

restructuredtext - 在 docutils 的表中插入图形指令

我正在尝试制作一张里面有一些人物的桌子。我在问是否有可能在 Docutils 或其他一些标记语言中做到这一点。我正在尝试这种表:

+-----------------+--------+--------------------------------------------+ | Prova | Prova | Cella Molto lunga | +-----------------+--------+--------------------------------------------+ | Visualizzazione | Figura | .. figure:: ~/Dropbox/rst/Pics/plantum.png | | | | :alt: Prova | +-----------------+--------+--------------------------------------------+
结果是桌子

0 投票
1 回答
170 浏览

python - 防止在 LaTeX 输出中转义特殊字符

默认情况下,Sphinx 生成的 LaTeX 输出会转义 LaTeX 标记。所以如果我写:

通话后make latexpdf

在乳胶中。所以所有的字符都被转义了,它不再是 LaTeX 代码了。有没有办法将 LaTeX 代码直接传递给 Sphinx 生成的 tex 源?

MWE 是做一个sphinx-quickstart接受默认值,然后在某处输入上面的 ReST 代码index.rst,最后用make latexpdfmake.bat latexpdf在 Windows 上)构建东西。

0 投票
1 回答
177 浏览

python - NumpyDoc 检查是否符合文档规范?

Numpy 项目为其文档的格式提供了规范,以支持可读性和自动提取(链接)。他们还提供Numpydoc作为 Sphinx 的扩展,以支持提取一些额外的关键字。

在开始为 docutils 编写扩展之前,是否存在一个库来帮助内省现有的文档字符串并识别不符合 Numpy 标准的情况。

想象一个更成熟的库,其中包含大量文档,希望采用 Numpy 文档规范。一种方法是自省库并生成描述文档字符串状态的报告。

这是在开始将其作为 docutils 或 numpydoc 的扩展实现之前的侦察问题。我错过了现有的解决方案还是存在优雅的解决方案?

0 投票
2 回答
693 浏览

python - 使用 docutils 从 restructuredtext 中的 code 指令中提取代码

我想从重构文本字符串中的代码指令中逐字提取源代码。

接下来是我第一次尝试这样做,但我想知道是否有更好的(即更强大,或更通用,或更直接)的方式来做这件事。

假设我在 python 中有以下第一个文本作为字符串:

要获得这两个代码块,我可以这样做

现在source_code是一个列表,其中仅包含来自两个代码块的逐字源代码。如有必要,我也可以使用child的attributes属性来找出代码类型。

它可以完成工作,但是有更好的方法吗?

0 投票
1 回答
313 浏览

python - 使用 docutils 将 scipy 文档字符串(reST)转换为 HTML

我正在设计一个过滤器设计 GUI,并希望在 QTextBrowser 中显示来自 Python scipy.signal 的文档字符串,需要 HTML 格式。我认为 docutils 应该为我完成这项工作,我尝试过

其中 txtFiltInfoBox 是 QTextBrowser 实例。但是,publish_string 在它在文档字符串中遇到的第一个标题(“参数”)上阻塞:

我认为原因是该方法的整个文档字符串是缩进的,导致无效的 reST 标记。有没有一种简单的方法来减少文档字符串或告诉 publish_string 忽略一定数量的前导空格?

完整的代码可以在pyFDA 项目中找到。