reStructuredText中的小节

时间:2012-03-06 23:43:24

标签: restructuredtext

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

我希望文档有一个标题,这将是居中的,然后我立即想要一个小节。

我尝试过以下

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

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

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

3 个答案:

答案 0 :(得分:10)

从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并测试子标题与节标题等内容。

编辑:您也可以在标题和部分标题之间添加一些文字(例如摘要)。

P.S。我倾向于使用标题上方和下方的装饰来指示文档标题和副标题以及标题下方的单个装饰以指示(子)标题。这样可以很容易地看到我打算成为我的标题/副标题。例如:

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

Section
=======

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

答案 1 :(得分:0)

我认为让一个小节立即在节标题下开始是很自然的,如

我的事

我的第一件事

...

我的第二件事

...

我通过反复试验找到的解决方法是放置" \" (反斜杠空格)作为节标题和子标题之间的空内容。使用rst2html,这可以产生预期的效果,而不会引入任何不需要的空间。

答案 2 :(得分:0)

Chapter 1 Title
===============

Section 1.1 Title
-----------------

Subsection 1.1.1 Title
~~~~~~~~~~~~~~~~~~~~~~

Section 1.2 Title
-----------------

Chapter 2 Title
===============

请参见https://docutils.sourceforge.io/docs/user/rst/quickref.html#section-structure