reStructuredText 中的小节答案

【问题标题】：Subsections in reStructuredTextreStructuredText 中的小节
【发布时间】：2012-03-06 23:43:24
【问题描述】：

我正在尝试在 reStructuredText 中编写文档，但目前遇到问题。

我希望文档有一个标题，它会居中，然后紧接着我想要一个小节。

我尝试了以下操作

##############
Title
##############

+++++++++
Subtitle
+++++++++
content

但是当我将其转换为 PDF 时，它使标题和副标题都居中。

【问题讨论】：

我想你的意思是你想要一个紧跟在标题后面的部分，没有前面部分的小节没有多大意义。假设是这种情况，请参阅下面的答案。

标签： restructuredtext

【解决方案1】：

从 reStructuredText quick start guide 标题和副标题指定如下（强调我的）：

要在 reStructuredText 中指示文档标题，请在文档开头使用独特装饰样式。要指示文档副标题，请在文档标题之后立即使用另一种独特装饰样式。

因此，在问题的 reST 示例中，Subtitle 被格式化为子标题而不是章节标题，因为在文档中的其他任何地方都没有使用围绕 Subtitle 使用的装饰样式。在下文中，此装饰用于两个部分标题，因此不是唯一的，不被视为副标题：

##############
Document Title
##############

+++++++++++++++
Section 1 Title
+++++++++++++++

Section 1 content...

+++++++++++++++
Section 2 Title
+++++++++++++++

Section 2 content...

试一试http://www.tele3.cz/jbar/rest/rest.html 这让您可以快速尝试一些简单的 reStructuredText 并测试诸如副标题与章节标题之类的内容。

编辑：或者，您可以在标题和章节标题之间放置一些文本（例如摘要）。

附：我倾向于使用标题上方和下方的装饰来指示文档标题和子标题，并在标题下方使用单个装饰来指示（子）节标题。这样可以很容易地看到我打算成为我的标题/副标题。例如：

==============
Document title
==============
-----------------
Document subtitle
-----------------

Section
=======

Sub-section
-----------
etc.

【讨论】：

正是我所缺少的，更多部分。谢谢。
感谢您的回答。我发现它很有帮助。只是补充。我还找到了这个页面：sphinx-doc.org/rest.html#sections，它描述了用于选择装饰的 Python 约定。它说：#带有上划线，用于部分； * 带有上划线，用于章节； =，对于部分； -，对于小节； ^，对于小节； "，用于段落；
如果您的所有标题/标题/副标题样式都是唯一的，因为您有一个只有一章的简短文档，该怎么办？那么它如何区分标题和标题/副标题呢？

【解决方案2】：

我认为在一个小节标题下立即开始一个小节是很自然的，就像在

我的东西

我的第一件事

...

我的第二件事

...

我通过反复试验找到的解决方法是将“\”（反斜杠空格）作为空内容放在节标题和小节标题之间。使用 rst2html 可以达到预期的效果，而不会引入任何不需要的空间。

【讨论】：