问题标签 [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 回答
2569 浏览

python - 狮身人面像文档,编号图参考

我正在尝试使用 latexpdf 输出在我的 Sphinx 文档项目中使用编号的数字。我安装了在这里找到的 Sphinx numfig.py 扩展https://bitbucket.org/arjones6/sphinx-numfig

但是,每当我使用 :num: 应该提供与图形编号的交叉引用的标签时,我都会得到以下信息

第一次

生成输出:

参考标志图??

难道我做错了什么?

0 投票
1 回答
413 浏览

image - reStructuredText 中带有超链接的图像

我正在尝试添加带有外部链接的图像。

上面的代码显示了图像,但是如何将这些图像链接到外部站点?

谢谢!

0 投票
1 回答
698 浏览

restructuredtext - 如何在重组文本的链接中制作逐字文本?

如何在重组文本的链接中制作逐字文本?

这是我想要实现的目标:

example

我尝试了以下

但两种情况都呈现为

0 投票
1 回答
477 浏览

python - 将节点添加到第一个文档树并保存到文件

我想在文档树中插入一个自定义节点并将这些更改保存到文件中。

我正在阅读以下 RST 文件...

像这样:

我现在想在 docinfo 中插入一个新节点 :id: 234123 并将其保存为 test.rst。但是怎么做?

0 投票
1 回答
93 浏览

python - 将reStructuredText中的字段转成html

所以我有一个 reStructuredText 文档,其中包括以下字段:

我想将 rST 转换为 html,并对param(和其他)字段进行特殊处理。

可以按照此处docutils.core.publish_parts的建议将 rST 转换为 html ,但显然无法控制字段的输出方式。或者我可以按照这里的建议使用来获取伪 XML,并且大概(相当乏味)修改它,但我不知道如何控制如何将其转换为 html。docutils.core.publish_doctree

我可以看到 中有一个HTMLTranslatordocutils.writers.html4css1.__init__.py,但我肯定不能仅仅为了控制字段的输出方式而修改它吗?我希望某处有某种模板系统可以控制如何将 XML 转换为 html ...

0 投票
3 回答
453 浏览

python - 解决 RestructuredText 中的替换问题

我想采用以下包含替换定义的重组文本片段:

并解析定义,以便显示替换文本:

docutils 或其他模块中是否有可以执行此操作的功能或实用程序?

0 投票
1 回答
1660 浏览

python - 使用 Docutils 即时将 rST 解析为 HTML

我想动态地将 .rst 文件解析为 .html 文件以显示为网页。我正在使用金字塔,我还没有找到关于如何在 python 代码中使用 docutils 并将其写入缓冲区的任何快速帮助。

任何人都有任何指向简单教程的链接或任何其他关于如何做到这一点的建议?

0 投票
1 回答
1562 浏览

python - 使用 reST 嵌套 Sphinx 扩展指令

我试图弄清楚是否有办法嵌套 Sphinx 扩展指令。我有一些运行良好的自定义节点类型,但我希望在生成的 HTML 中有更多的灵活性。

这是我要完成的示例:

假设我有一个指令,它创建一个触发一些 JavaScript 的文本框和按钮。这很好用 - 我可以把它放在我的 reST 文件中:

现在,我希望能够在输出中使用 jQuery 创建一个选项卡式界面。我有一个节点类型,可以创建发生这种情况所需的原始 HTML/JavaScript。

我想要做的是给选项卡节点 1 个或多个 myDirective (或其他指令)实例,并让它将每个实例放入另一个选项卡。像这样的东西:

显然这是一个非常具体的案例,但这通常是我想要完成的——嵌套指令。

0 投票
1 回答
68 浏览

attributes - Sectioning / grouping attributes inside a class

I have a class with a large number of attributes; I would like to present them grouped (rather than in a flat list), with a section-like appearance inside the class documentation.

Is this possible with docutils/sphinx? Any suggestion to achieve something visually similar, perhaps by inserting dummy attributes?

0 投票
1 回答
404 浏览

python - 在 reStructuredText(使用 Spinx)中使用文字块时如何修复列表缩进?

对于一个文档项目,我想给出代码示例作为项目符号列表。我使用 Sphinx 将 .rst 文件转换为 HTML。这很好用,直到我开始在列表项中使用文字块。在下面的示例中,我想在与“给定一个 XML 文件...”相同的级别上显示句子“执行以下代码之后”。但是它会自动缩进。

PS:别管代码,它是一种特殊的语言。