问题标签 [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 投票
1 回答
1436 浏览

documentation-generation - 使用 RestructuredText 和 Sphinx 包含预格式化文件

我正在尝试使这个片段工作:

也就是说,使用 include 指令将文件作为块引用包含在内。一旦进入块引用,指令就会被引用。我想要块引用中的文件内容。

知道怎么做吗?

0 投票
2 回答
3026 浏览

python-sphinx - Sphinx:交叉引用索引项

如何交叉引用 reStructuredText 文档中的索引项?

例如,我如何交叉引用 SectionB:

我尝试在引用中使用索引标签,例如:

但这不起作用。

0 投票
1 回答
106 浏览

restructuredtext - 如何在 ReST 中返回更高的嵌套级别?

在重组文本中,我该如何写:

0 投票
5 回答
16055 浏览

restructuredtext - 在 Sphinx 和 reStructuredText 中引用带有数字的数字

在编写将使用Sphinx处理的 RST 时,我无法让 Sphinx LaTeX 输出在引用数字时使用数字数字。例如,这段代码:

会转换成这样:

旅鼠正在攻击,正如他们来了!

/图片在这里/

图 1.1:他们来了!

但我想要的是引用数字的“标准”LaTeX 方式,如下所示:

旅鼠正在攻击,如图 1.1 所示

我如何实现这一目标?我目前使用的代码是 Sphinx 手册推荐的,但它不会产生我想要的输出。

0 投票
1 回答
566 浏览

restructuredtext - reStructured Text - 转义标题?

我有一个 reStructuredText 文档。rST 使用=====等作为标题格式。

但是,我需要包含一些包含此文本的行,例如:

而且我不希望====被解释为标题,即我不想stuff成为标题。我宁愿那些等号按原样显示。

这在 rST 中可能吗?

0 投票
1 回答
120343 浏览

restructuredtext - reStructuredText 工具支持

我是reStructuredText的忠实粉丝,但是支持它的工具分散在整个 Internet 上。官方工具列表不完整和/或过时,只能通过提交权限进行更新。一段时间以来,在Wikipedia reStructuredText 页面上有一个综合列表,但这显然“不符合 web 内容的知名度指南并被删除

因此,以问题形式提出:在使用 reStructuredText 时可以期望找到哪些工具支持,例如文本编辑器、Wiki 软件、与 reStructuredText 之间的转换器等?

0 投票
9 回答
4673 浏览

python - 是否有 ReST 文件的智能编辑器?

我正在学习 Sphinx,我需要编辑 ReST 文件。有智能编辑器吗?比如,一个给我代码着色、简单缩进、代码完成(希望如此)等的编辑器。

0 投票
2 回答
281 浏览

documentation - 需要建议 - 开发灵活的文档系统,重点关注本地化

我负责构建文档系统/平台。

以下是主要要求的简短列表:

  • 易于本地化:这将需要支持十几种语言。(非技术人员添加/更新翻译的能力将是一个很大的优势,尽管不是 100% 需要)

  • 输出格式的灵活性:至少,我需要将文档(作为一个整体或选定的块)输出为 PDF 和 HTML。Windows 帮助文件等原生格式的奖励积分。

  • 通过直观的用户界面(最好是 Web)进行管理和部署。

我想知道你们是否知道已经支持这种类型的任何系统?我不反对从头开始写这篇文章,但如果我能帮上忙,我宁愿不重新发明轮子。

到目前为止,我遇到的两个主要候选人是DocBookreST。前者似乎以吸吮而闻名。我对这两个都不熟悉,但有人告诉我,reST 可以让我在其中大获成功。

还有其他建议吗?从头开始构建它会更好吗?

0 投票
3 回答
650 浏览

python - Python 的网站如何生成其在线文档?

使用 Sphinx 0.6.5 创建。

我知道 Python 的文档使用reStructuredText,但它有不同的部分,例如http://docs.python.org/whatsnew/2.6.htmlhttp://docs.python.org/tutorial/index.html

你如何在 reStructuredText 中做到这一点?您是否rst2html在一堆目录中运行并保持其结构?

我知道它使用 Sphinx(不是Thomas Wouters 在回答中直接说的 rst2html ),但是您应该如何在存储库中使用源代码文件组织您的第一个结构,以便拥有一个完整的自动化文档网站?

0 投票
1 回答
439 浏览

diff - 使用 rst2pdf 可视化 rst 差异

有没有一种简单的方法可以使用rst2pdf可视化 rst 文件之间的差异?我知道我可以使用 rst2latex 代替,然后使用 latexdiff 来生成 PDF 文件(这就是我所追求的效果),但我希望在原始文件和 diff 文件中具有相同的样式。