4. Sphinx#
4.1. reStructureText 中的段落#
👉 官网参考文档
目录级别 |
标记符号 |
备注 |
|---|---|---|
一级 |
# |
Parts |
二级 |
* |
Chapters |
三级 |
= |
Sections |
四级 |
- |
Subsections |
五级 |
^ |
Subsubsections |
六级 |
" |
paragraphs |
备注
标题下的标记符号长度必需长于标题文本长度
4.2. Sphinx 把文章分为多个短文章#
如果我们把所有内容都写在同一个 rst 源文件中，就有可能出现源文件很长的情况。 修改和查找起来就不哪么容易。
我们可能将文章中较长的章节提取出来，单独写在一个文件中在主文章中使用 include 指令引用该文章即可 来引入该节文字
备注
注意文章的标题级别