问题标签 [docutils]

我在 reStructuredText 中有以下整洁的小表格：

根据关于简单表格的 Docutils 文档，我希望 Spinx 生成的结果 HTML 表格与文本中的布局一样，因此“yy”和“yyyy”将位于不同的行上，“M”、“MM”也是如此“ 等等。然而结果是这样的：

我尝试了一些替代方法，例如在最后一列的开头使用管道 (|)、空行、缩进。我最接近的是在“yyyy”之前使用缩进。然后“yyyy”在下一行，但它是缩进的。当然，我希望它与“yy”处于相同的缩进级别。

For a documentation project I am writing I need to include a table with date format strings. Now almost everything works fine, but at the end I have this slight problem where I want to print a literal ' quote and two literal quotes (separately and between other quotes). Sphinx changes these to up/down quotes, which usually looks really neat, but in this particular case makes the text unreadable. The best I could come up with was:

This produces all the right quotes, but it inserts extra spaces before and after, which I would like to see removed, since the example is not syntactically correct that way. So one could also rephrase my question as: How to remove extra spaces before and after literal quotes when using backticks.

I have tried standard ways of escaping. Backslashes have no effect, since ' is not a reStructuredText special character. If I remove the spaces the backticks `` won't work anymore.

Sample output with extra spaces:

我在我的 Windows XP 桌面上的 Virtual Box 上使用 Fedora 18 来学习 Django。在浏览了.txt文档文件后，我发现这些文件是使用 restructuredText 编写的。我花了最后一天左右的时间试图弄清楚如何将文件转换为可读的东西（HTML、Latex、PDF 等）。我做的第一件事是安装 docutils（从源代码- 下载页面）并用于rst2html.py将文件转换为 HTML 以便可读。

当我使用这个工具时，我在打开,和文件时收到了Unknown interpreted text role "doc", Unknown interpreted text role "ref",Unknown interpreted text role "term"错误等等。我在 Google 上几乎找不到描述我遇到的确切问题的信息，所以我尝试使用不同的选项。docs/intro/index.txtdocs/intro/install.txtdocs/intro/tutorial01.txt

天真地认为错误是 docutils 所固有的，我决定搜索另一个工具并找到此页面并安装了 restview。好吧，我没有意识到 restview 使用了 docutils，所以我最终回到了第一方。

我如何摆脱这些和其他错误？我是否正确安装了 docutils 和 restview？

请告诉我是否需要添加更多信息

我可以docutils用来解析 reStructuredText 格式的文档字符串，但它不解析属于 Python 域的指令本身。例如，:type path: unicode被解析为：

我可以使用 Sphinx 以编程方式从中获得更多意义吗？即参数名称等？

我可以有一个 conf 变量的页面本地值（通常在 中找到conf.py）吗？

例如，我有

在conf.py. 我可以拥有吗

对于 sphinx 文档的给定 ReST 页面？

是否有格式化练习的环境？就像是

即，这是一个指导性文档，挑战读者阅读材料。

我编写了一个自定义的 ReST 指令，它接受这样的输入：

并输出一个表格。桌子的形状像上面的字母块，每个字母代表一个图像。接下来的几行将图像与每个字母相关联。

这是执行输出的指令部分：

这“有效”，因为它返回正常。但后来，当作者试图输出我的指令返回的内容时，它会导致回溯：

这似乎是docutils¹ 中的一个错误；我猜我返回的表格元素不是很“格式良好”，至少对作者来说是这样。但是，似乎没有任何关于此的文档。（如果有，请指点我！）

有谁知道我返回的 HTML 作家不喜欢的表节点是什么，以及我应该改变什么来修复它？

¹即使我的输出不好，也应该将比“列表索引超出范围”更好的错误发回给我。

The Docutils Hacker's Guide的Parsing the Document部分提到了可用于打印已解析reStructuredText文档的节点树表示的实用程序。但是我在安装在 .docutils 发行版中的任何地方都找不到。还有其他方法可以打印文档树吗？quicktest.pyquicktest.py/usr/lib/python2.7/dist-packages/docutils

考虑一个带有这个骨架的 reStructuredText 文档：

该my-import-from指令由特定于文档的 Sphinx 扩展提供，它应该读取作为其参数提供的文件，解析其中嵌入的 reST，并将结果作为当前输入文件中的一个部分注入。（与 autodoc 类似，但文件格式不同。）我现在拥有的代码如下所示：

这是可行的，除了新部分是作为当前部分的子部分注入的，而不是兄弟部分。换句话说，上面的示例文档生成了一个如下所示的 TOC 树：

• 主题
  • 小节
    • 文件 1
    • 文件2

而不是想要的

• 主题
  • 小节
  • 文件 1
  • 文件2

我该如何解决？Docutils 文档......不足，特别是在控制部分深度方面。我尝试过的一件显而易见的事情是返回doc_section.children而不是[doc_section]; 完全从 TOC 树中删除File1和删除File2（但确实使文档正文中的节标题看起来是正确的嵌套级别）。

对于崇高的文本，我安装了 RstPreview，下载docutils-0.11并通过在命令提示符下运行安装它C:\Anaconda\python setup.py install（我使用的是 windows 7 64 位）。

当我按下Ctrl+Shift+R解析.rst文件时，我得到以下信息，

构建系统设置为C:\Anaconda\pythondocutils 正常导入的位置，但看似崇高的文本尝试docutils从我不知道如何安装库的内部 Python 系统导入。

提前致谢！