restructured

text style

斜体: *

加粗: **

block: ``

链接

内部链接

`内部链接 <https://www.sphinx-doc.org/>`_

如果你都是中文,前后无法有空格, 就要用转义符. 比如百度的网址

wikipedia参考

source

sphinx

标题用=

三级标题

四级标题

五级标题
https://devguide.python.org/documentation/markup/#sections
标题用= sections
=======
二级标题 subsections
--------
后面是
^^^^^ subsubsections
~~~~~~ 这个波浪号不再python规范里, 但是有用
"""""" paragraph

代码用'.. code::'

.. code::

    这里是代码

列表

列表用:

  • 无序列表用-

- 无序列表用-
  1. 自增

#) 自曾
  1. 自增

  1. 设置自增ID

代办事项

待处理

代办事项todo wer

include

include会直接复制过来 但是超过了级别不行

同级别也可以

我辈include

被include的

级别要一致

toctree会当作上面的最后一个标题的子元素

  • 我想toctree但是当作大标题, 不行