rst标记语法

插入链接

`Hypernets <https://github.com/DataCanvasIO/Hypernets>`_

效果：
Hypernets

注意开始插入链接标记的开始和结束都要有空格。

行内标记

``Searcher ``

这个标记前后也要有空格。

效果：
Searcher

标题

一级标题：

我是一级标题
======

相当于markdown的:

# 我是一级标题

二级标题：

我是二级标题
-----

插入图片

.. image:: images/hypergbm-main-components.png

这个标记前后要有空行，并且上下的文字都不能有缩进。

插入代码

这是一行

.. code:: python

    import numpy as np

这是一行

注意，这个也是标记前后有空行，并且上下的行都没有缩进，并且代码块的第一行需要为空行。

列表

列表的语法与markdown 一致：

* 标题
 - 标题

sphinx 创建索引

.. toctree::
   :maxdepth: 2
   :caption: Home:

   概览<overview.rst>
   安装教程<installation.md>
   快速开始<quick_start.md>

上下段落需要有空行，被引用的文件内必须有标题，否则html页面上没有菜单。

参考

• https://zh-sphinx-doc.readthedocs.io/en/latest/rest.html#id35