reStructuredText中的小节

Mah*_*sam 5 restructuredtext

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

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

我尝试过以下操作

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

+++++++++
Subtitle
+++++++++
content
Run Code Online (Sandbox Code Playgroud)

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

Chr*_*ris 11

从reStructuredText 快速入门指南标题和子标题指定如下(强调我的):

要在reStructuredText中指示文档标题,请在文档的开头使用唯一的装饰样式.要指明文档字幕,请在文档标题后立即使用另一种独特的装饰样式.

因此,在问题的reST示例中,Subtitle格式化为子标题而不是节标题,因为Subtitle在文档中的任何其他位置都不使用周围使用的装饰样式.在下文中,这个装饰用于两个章节标题,因此不是唯一的,不作为副标题处理:

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

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

Section 1 content...

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

Section 2 content...
Run Code Online (Sandbox Code Playgroud)

http://www.tele3.cz/jbar/rest/rest.html一起.这允许您快速尝试一些简单的reStructuredText并测试子标题与节标题等内容.

编辑:或者您可以在标题和节标题之间放置一些文本(例如,抽象).

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

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

Section
=======

Sub-section
-----------
etc.
Run Code Online (Sandbox Code Playgroud)

  • 谢谢你的回答.我发现它很有帮助.只是补充一下.我还找到了这个页面:http://sphinx-doc.org/rest.html#sections,它描述了用于选择装饰的Python约定.它说:#带上线,零件;*有上线,章节; =,对于部分; - ,对于小节; ^,用于子部分; ",对于段落; (2认同)