问题标签 [restructuredtext]

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 投票
5 回答
15741 浏览

python - 如何右对齐 reStructuredText 简单表中的列内容?

我正在使用Sphinx编辑我的一个项目的文档,该项目又使用reStructuredText作为标记语言。

我有一个简单的表格(而不是grid table),其中最右边的列报告包含我想右对齐的数字,但我找不到如何实现这一点。

如果这能让我解决问题,我很乐意切换到网格表。

0 投票
3 回答
2156 浏览

documentation - 如何编写自动包含在 Doxygen 输出中的自述文件?

从概念上讲restructuredtext,我想在我的不同源目录中分发自述文件,然后让Doxygen读取并将这些自述文本文件包含在生成的 Doxygen 输出中。

这是怎么做到的?或者我是否需要通过创建一个伪 C 文件来欺骗 Doxygen,例如:

自述文件.h:

0 投票
1 回答
2915 浏览

latex - 我可以在 reStructuredText 中使用内联原始 LaTeX

我正在尝试将 LaTeX 变量嵌入到一些 reStructuredText 中。我知道“.. raw::”指令,但我希望将其嵌入一段文本中。具体来说,我希望从模板考试文档中复制 \numquestions\ 和 \numpoints\ 变量。我曾尝试使用 :raw: \numquestions\,但这似乎无效。有没有办法做到这一点?

0 投票
1 回答
1562 浏览

python-sphinx - 如何在不使用 RST 表格格式的情况下在 reStructuredText 中生成表格输出?

我正在尝试将我们的 API 文档及其专有文档生成器架构迁移到 reStructuredText。最困难的部分是,我们有一个 API 详细信息的表格表示,直接用 HTML 编码,例如:

(即当前编码为<tr><td class='param'>id</td><td class='required'>Yes</td>...

我想在 RST 中执行此操作,但要在语义上执行,而不仅仅是使用 RST 表格式。但是我找不到任何自定义指令的好例子来按我想要的方式处理这个问题,就像

我怎样才能在 reStructuredText 中做到这一点?

0 投票
1 回答
607 浏览

django - 处理乳胶代码的django标记处理器

Django 有一个内置的模板过滤器,可以处理重组的文本。是否可以像 sphinx(文档生成器)处理乳胶代码一样使用它来处理乳胶代码,例如

哪个被转换为png图像?

我知道我可以编写自己的第一个处理器来处理我的 django 中使用的乳胶代码,我只是想知道这是否已经完成。

感谢您的任何建议或建议-m

0 投票
1 回答
152 浏览

python - 在 reST 指令中创建图像

我正在尝试创建一个 reStructuredText 指令来获取它的内容,使用 PIL 基于该内容创建一个图像,然后在文档中显示生成的图像。到目前为止,我所做的是将 image 指令子类化,在某个路径(例如 images/diagram.png)创建文件,然后将 images/diagram.png 传递给 image 指令。这样做的问题是文件被保存到 ./images/ 但生成的 html 文档在 {output_dir}/static/images/ 中查找它。

我的问题是如何访问 reST 用于存储输出的目录的值,以便将图像存储在正确的位置?

0 投票
3 回答
1193 浏览

vim - 是否有一个插件可以在 vim 中显示 rst 的轮廓

有没有办法在 vim 中显示 rst 文件的大纲?这可以让我更快地跳到部分。

我希望它提供像 nerdtree 这样的功能。最好在另一个单独的窗口上显示。

或者,是否有任何方法可以折叠 RST 文件?

0 投票
1 回答
623 浏览

javascript - 使用 javascript 代替 Sphinx 的默认目录树

我正在使用 sphinx 自动生成 html 页面。目录真的很长,所以我试图在toctree的 div 中添加一个新的 html 类(除其他外),这样我就可以使用 javascript 库。基本上是想改变 toctree 生成其 HTML 的方式。

我找到了globaltoc.html文件,将其放在_templates文件夹中,并在conf.py中取消了template_path的注释。

这是_templates目录中的文件。

如果我这样做完全错误,请告诉我另一种方法。我希望能够在纯粹的 reST 中做到这一点,但这似乎是不可能的。我已经查看了有关 Sphinx 模板的有限示例,这就是我能找到的全部内容。

这样做的总体目标是将dhtmlxTree用于非常大的树。我已经将所需的 .js 文件和 .css 文件添加到layout.html。我只需要包含目录树的div就可以拥有我需要的类。我可以通过手动编辑得到我需要的结果,现在我需要自动化它。

谢谢你的帮助。

0 投票
1 回答
1382 浏览

python-sphinx - 在 Sphinx 中的引用中保留内联代码

在 Sphinx 中,如果我有以下标题声明:

它呈现,如下所示:

    this is code, 这不是!

这很好,但是,如果我使用参考,例如:

它丢失了代码格式并呈现如下:

    看看这是代码,这不是!

代替:

    看看this is code,这不是!


是否可以在参考中保留代码格式?我该怎么做呢?

0 投票
1 回答
2500 浏览

python-sphinx - 如何在 reStructuredTest/Sphinx 中语法高亮 XML

在 Sphinx/reST 中添加 xml 以使其正确显示在生成的文档中的建议方法是什么。