[TOC] <br/><br/><br/> # <b style="color:#4F4F4F;">简介说明</b> 原文链接： - [pythondoc](http://www.pythondoc.com/sphinx/rest.html) - [sphinx-doc](https://zh-sphinx-doc.readthedocs.io/en/latest/rest.html) ``` 版本：reStructuredText 作用：轻量级标记语言的一种 ``` <br/> # <b style="color:#4F4F4F;">排版元素</b> <br/> # <span style="color:#619BE4">=========</span> ***** 一级标题 <br/> # <span style="color:#619BE4">------------------</span> ***** 二级标题 <br/> # <span style="color:#619BE4">^^^^^^^^^^^^^^^^^^^^</span> ***** 三级标题 <br/> # <span style="color:#619BE4">\*text\*</span> ***** 强调 (斜体) <br/> # <span style="color:#619BE4">\*\*text\*\*</span> ***** 重点强调 (加粗) <br/> # <span style="color:#619BE4">\`\`code\`\`</span> ***** 代码样式 <br/> # <span style="color:#619BE4">\`描述<链接地址>\`_</span> ***** 超链接 <br/> ### 示例内容 <span style="color:red;">1. 举例说明</span> ``` `baidu <http://www.baidu.com>`_ ``` <br/> # <span style="color:#619BE4">* </span> ***** 无序列表 <br/> # <span style="color:#619BE4">#. </span> ***** 有序列表 <br/> # <span style="color:#619BE4">1. </span> ***** 有序列表 <br/> # <span style="color:#619BE4">\| </span> ***** 分割句子 <br/> # <span style="color:#619BE4"> :ref:\`锚点名称\`</span> ***** 定义可跳转的锚点 <br/> ### 示例内容 <span style="color:red;">1. 举例说明</span> ``` .. _my-reference-label: :ref:`my-reference-label` ``` <br/> # <span style="color:#619BE4"> :emphasis:\`字体\`</span> ***** 斜体字 <br/> # <span style="color:#619BE4"> :strong:\`字体\`</span> ***** 粗体字 <br/> # <span style="color:#619BE4"> :literal:\`字体\`</span> ***** 斜体字 <br/> # <span style="color:#619BE4"> :subscript:\`字体\`</span> ***** 上标 <br/> # <span style="color:#619BE4"> :superscript:\`字体\`</span> ***** 下标 <br/> # <span style="color:#619BE4"> :title-reference:\`字体\`</span> ***** 书刊引用 <br/> # <span style="color:#619BE4">|name|</span> ***** 定义可替换块 <br/> ### 示例内容 <span style="color:red">1. 举例说明</span> ``` .. |name| replace:: replacement *text* .. |caution| image:: warning.png :alt: Warning! ``` <br/> # <span style="color:#619BE4">..image::</span> ***** 定义图片 <br/> ### 示例内容 <span style="color:red">1. 举例说明</span> ``` |引用名称| .. |引用名称| image:: https://travis-ci.org/SystemLight/madtornado.svg?branch=master :target: https://travis-ci.org/SystemLight/madtornado ``` <br/> ### 参数说明 <b style="color:#808080;">target</b> * 类型：字符串 * 默认值：无 * 描述：跳转链接 * 可选值：[ ] <br/> # <span style="color:#619BE4">..figure::</span> ***** 引用图片渲染 <br/> ### 示例内容 <span style="color:red;">1. 举例说明</span> ``` .. _my-figure: .. figure:: https://timgsa.baidu.com/timg?image&quality=80&size=b9999_10000&sec=1598783977266&di=b73018ff6f9fb35b250711dcb7a6b912&imgtype=0&src=http%3A%2F%2Ft8.baidu.com%2Fit%2Fu%3D2247852322%2C986532796%26fm%3D79%26app%3D86%26f%3DJPEG%3Fw%3D1280%26h%3D853 Figure caption :ref:`my-figure` ``` <br/> # <span style="color:#619BE4">..function::</span> ***** 调用python函数 <br/> ### 参数说明 <b style="color:#808080;">module</b> * 类型：字符串 * 默认值：无 * 描述：指定模块路径 * 可选值：[ ] <br/> ### 示例内容 <span style="color:red">1. 举例说明</span> ``` .. function:: foo(x) foo(y, z) :module: some.module.name 返回用户输入的一行文本. ``` <br/> # <span style="color:#619BE4">.. rubric::</span> ***** 声明尾注 <br/> ### 示例内容 <span style="color:red">1. 举例说明</span> ``` Lorem ipsum [#f1]_ dolor sit amet ... [#f2]_ .. rubric:: Footnotes .. [#f1] 第一条尾注的文本. .. [#f2] 第二条尾注的文本. ``` <br/> # <span style="color:#619BE4">.. [Ref]</span> ***** 定义参考 <br/> ### 示例内容 <span style="color:red">1. 举例说明</span> ``` Lorem ipsum [Ref]_ dolor sit amet. .. [Ref] 参考文献, 书,URL 等. ``` <br/>