47 lines
876 B
ReStructuredText
47 lines
876 B
ReStructuredText
===============
|
||
基础文档示例
|
||
===============
|
||
|
||
这是 reStructuredText(RST)格式的基本示例文档。
|
||
|
||
章节标题
|
||
========
|
||
|
||
RST 使用下划线来标记标题层级,常见的标记符号包括:
|
||
``=``、``-``、``~``、``^``、``"`` 等。
|
||
|
||
小节节标题
|
||
-----------
|
||
|
||
这里是小节内容。RST 支持多种内联标记,如 **粗体**、*斜体*、`行内代码` 等。
|
||
|
||
列表示例
|
||
--------
|
||
|
||
无序列表:
|
||
|
||
- 第一项
|
||
- 第二项
|
||
- 嵌套项 A
|
||
- 嵌套项 B
|
||
- 第三项
|
||
|
||
有序列表:
|
||
|
||
1. 第一步
|
||
2. 第二步
|
||
3. 第三步
|
||
|
||
引用与链接
|
||
----------
|
||
|
||
> 这是一段引用文本,通常用于引用他人的话语或重要提示。
|
||
|
||
访问 `Python 官方网站 <https://www.python.org/>`_ 获取更多信息。
|
||
|
||
也可以这样定义链接:
|
||
|
||
`Sphinx 文档`_ 是学习 RST 的好资源。
|
||
|
||
.. _Sphinx 文档: https://www.sphinx-doc.org/
|