问题标签 [restructuredtext]

在 rst2html 生成的 HTML 输出中，所有级别的节都带有“节”类。我可以配置吗？

因此，如果我想将自己的 CSS 应用于 HTML 输出，我不能对顶级部分和子部分使用不同的样式，因为它们具有相同的类名？

如果我想对不同级别的部分应用不同的样式，如何解决这个问题？

我正在制作一个框架，让开发人员在其中使用 reStructuredText 描述他们的包。我想将该 reStructuredText 解析为 HTML，以便可以在 GUI 中显示它。

我对出色的 Sphinx 很熟悉，但我从未解析过 reStructuredText。我想像一个函数，它接受一个 reStructuredText 字符串，可能还有几个额外的参数，并返回一个 HTML 字符串。

所以我查看了负责解析reStructuredText的Docutils。我完全不明白如何找到这个功能。网络上的文档参差不齐。该模块中的许多功能docutils.parsers.rst似乎都针对文件名。我没有文件名！我只是在处理字符串。

我尝试创建 aParser和 aDocument并使用该parse方法，但我只是收到有关缺少.tab_width设置的错误。

有谁知道如何将 reStructuredText 解析成 HTML？

下面是我的代码

我收到以下错误：

所以，我args改为：

现在，没有错误。但是，插入 HTML 输出的样式表不是/home/wonder/lab/css/note.css. 它仍然是/usr/local/lib/python2.7/dist-packages/docutils/writers/html4css1/html4css1.css。

也就是说，与使用 publish_cmdline 时在命令行中指定选项不同，settings_overrides带有 HTML-Specific Options 的参数在使用 publish_string 时不起作用。

我在 PyCharm 中有一个文件，它曾经只是一个.txt文件。现在我想使用.rst（reStructuredText）。

我知道当我第一次打开一个没有结尾的文件时，PyCharm 会询问我它是什么类型的文件以及应该如何解释语法。

我可以以某种方式再次打开该对话框，还是可以以其他方式更改关联？

我正在使用reStructuredText制定一个简单的清单。为此，我使用了项目符号列表，但我想用自定义符号替换标准项目符号，例如空复选框。理想情况下，复选框可以在 HTML 和/或 PDF 文档中单击。

如果在 reST 中不可能/微不足道，您能否推荐其他可能的基于文本的格式？

巴托什

我想为我的一个基于 Django 的项目编写文档。我发现 Django 人为此使用 reStructureText 和 Sphinx。我有以下疑问。

• 如何开始使用 reStructureText 和 Sphinx 编写文档？
• 我应该遵循哪些最佳实践，以使文档保持井井有条、易于理解和易于管理的版本化？

我正在寻找一个 Javascript API 文档框架，其功能类似于 JSDoc，但会在代码注释（不是 html）中使用易于键入的重组文本或 markdown

奖励：将与 Sphinx 很好地集成。但是，我不想维护单独的文档，而是从注释中生成 API 文档。

http://code.google.com/p/jsdoc-toolkit/

在 RST 中，我们在块前面使用一些空格来表示这是一个代码块。因为 Python 还使用空格来缩进代码块，所以如果我正在编写 Python 代码，我希望我的 RST 代码块保留这些空格。我怎样才能做到这一点？

假设我们有一个类：

我们想写一个方法叫做__init__这个类的成员。此方法属于另一个代码块，但我们希望有一些视觉线索，以便读者知道第二个代码块是前一个代码块的延续。目前，我使用#这样标记代码块的垂直引导线：

如果没有#,def __init__(self)将会以与 . 相同的缩进级别打印class Test(object)。必须有更优雅的方式。

以下如何在带有 ReStructured Text (rst2html.py) 的文本中使用颜色或如何在没有空行的情况下插入 HTML 标签？我能够在表格中设置文本的背景，如下所示：

这导致单词“avail”在字母后面有一个绿色背景，但是我怎样才能让整个单元格有一个彩色背景，而不仅仅是这些字母后面的一部分呢？

我正在使用Sphinx为我的项目生成文档。

在这个项目中，我在一个yaml文件中描述了一个可用命令列表，一旦加载，就会生成一个字典，{command-name : command-description}例如：

我想知道的是，sphinx 中是否有一种方法可以在循环期间加载 yaml 文件，以某种reStructuredText格式（例如定义列表make html）翻译 python 字典并包含在我的 html 输出中。

我希望我的.rst文件看起来像：

并在内部转换为：

在被翻译成 HTML 之前。