2.1. 标题学习¶
章节的标题在双上划线符号之间(或为下划线),并且符号的长度不能小于文本的长度。
通常没有专门的符号表示标题的等级,但是对于Python 文档,可以这样认为:
# 及上划线表示部分
及上划线表示章节
=, 小章节
-, 子章节
^, 子章节的子章节
", 段落
备注
因为rest对标题的分级没有详细描述,我们通过下方的标题的划分为参考规则。
================
标题学习1
================
二级标题是这样的
================
----------------
三级标题是这样的
----------------
四级标题是这样的
----------------
`````````
五级标题
`````````
六级标题
`````````
备注
需要注意的是,该标签分级不是固定的。标题的优先级与其出现的先后有关。即运行下方的代码的效果也是一样的。 点击前往下方代码运行结果界面
标题学习
````````````
``````````````````````
二级标题是这样的
``````````````````````
三级标题是这样的
----------------
----------------
四级标题是这样的
----------------
五级标题
==========
==========
六级标题
==========
以笔者常用的子章节和小章节的符号举例:对于 同一种类型符号 的双线以及单线标题,只要是其中双线先于单线出现,那么该先出现的 该类型的 双线标题的优先级高于单线的标题,且该优先级会影响该文件全局;反之也一样。
标题学习2部分代码如下:
=单线标题示例
=============
==============
二级=双线标题
==============
三级单线
-------------
----------
四级-双线
----------
直接对比标题学习1以及标题学习2的代码以及运行结果会更加明了。
2.1.1. 推荐标题分级¶
===================
推荐的标题分级
===================
推荐标题分级2
==============
推荐标题分级3
---------------
---------------
推荐标题分级4
---------------
2.1.2. title-directive / title指令¶
"title"指令将文档标题指定为元数据,它不会成为文档主体的一部分。 它覆盖文档提供的文档标题和“title”配置设置。 例如,在HTML输出中,元数据文档标题出现在浏览器窗口的标题栏中。
.. 在此代码块上的代码为:
.. title:: title-directive 指令之 标题学习