Sphinx文档

样式

标题

一级标题
=========
二级标题
---------
三级标题
~~~~~~~~~~~~~~~

其他样式

  • `斜体文字*`显示为*斜体文字
  • `粗体文字**`显示为**粗体文字
  • 符号列表使用`-, `+`或者`*
  • 顺序列表使用`1.`, A., `I.`或者`#.`自动编号
  • 注释,以`..`开头
  • 图片:.. image:: images/ball1.gif

超链接的格式为

`Google <https://google.com>`_

如链接到 Google

而内部引用文档的格式为

更多信息参考 引用文档_

这里是其他内容

.. _引用文档:

这是引用部分的内容

文字块

文字块需要在插入的地方以`::`+空行开始,如

下面是文字块内容:
::

这是第一行
这是第二行

下面是文字块内容:

这是第一行 这是第二行

而代码高亮则使用`.. code-block::`开始

.. code-block:: html

    <html>
    <body>Hello World</body>
    </html>

.. code-block:: python

    def hello():
        """Greet."""
        return "Hello World"
<html>
  <body>Hello World</body>
</html>
def hello():
    """Greet."""
    return "Hello World"

警告

支持多种警告格式,如:

.. note:: This is a **note**.

.. todo:: This is a **todo**.

.. warning:: This is a **warning**.

.. danger:: This is **danger**-ous.

注解

This is a note.

待处理

This is a todo.

警告

This is a warning.

危险

This is danger-ous.

脚注

脚注的格式为`[#f1]_`:

脚注 [#f1]_ 和脚注 [#f2]_ .

.. rubric:: Footnotes
.. [#f1] 脚注1.
.. [#f2] 脚注2.

脚注 [1] 和脚注 [2] .

Footnotes

[1]脚注1.
[2]脚注2.

表格

表格的格式如下:

.. cssclass:: table-bordered

+------------------------+------------+----------+----------+
| Header1                | Header2    | Header3  | Header4  |
+========================+============+==========+==========+
| row1, cell1            | cell2      | cell3    | cell4    |
+------------------------+------------+----------+----------+
| row2 ...               | ...        | ...      |          |
+------------------------+------------+----------+----------+
| ...                    | ...        | ...      |          |
+------------------------+------------+----------+----------+
Header1 Header2 Header3 Header4
row1, cell1 cell2 cell3 cell4
row2 ... ... ...  
... ... ...  

另外一种简单表格

=====  =====  =====
第1列  第2列  第3列
=====  =====  =====
8      1      6
3      5      7
4      9      2
=====  =====  =====
第1列 第2列 第3列
8 1 6
3 5 7
4 9 2

PlantUML

pip install sphinxcontrib-plantuml
wget https://nchc.dl.sourceforge.net/project/plantuml/plantuml.jar
mv plantuml.jar /usr/local/bin
cat <<EOF > /usr/local/bin/plantuml
#!/bin/bash
set -e
java -jar /usr/local/bin/plantuml.jar "$@"
EOF
chmod +x /usr/local/bin/plantuml
.. uml::
   :caption: Caption with **bold**
   :scale: 100 %
   :align: left

   Alice -> Bob: Hi!
   Alice <- Bob: How are you?

Alice -> Bob: Hi!
Alice <- Bob: How are you?

Caption with bold

目录索引

目录索引以toctree开始

.. toctree::
:maxdepth: 2

example1
example2