注释样例

docs/source/index.rst

@@ -56,6 +56,7 @@ fastNLP 在 :mod:`~fastNLP.models` 模块中内置了如 :class:`~fastNLP.models
     快速入门 <user/quickstart>
     详细指南 <user/tutorial_one>
     科研指南 <user/with_fitlog>
+    注释语法 <user/example>
 
 API 文档
 -------------

docs/source/user/example.rst

@@ -0,0 +1,104 @@
+======
+大标题
+======
+
+.. note::
+    中文标题需要符号的数量至少是中文字数的两倍
+
+.. warning::
+    符号的数量只可以多，不可以少。
+
+小标题1
+###########
+
+小标题2
+*********
+
+小标题3(正常使用)
+========================
+
+小标题4
+-------------------
+
+参考 http://docutils.sourceforge.net/docs/user/rst/quickref.html
+
+常见语法
+============
+
+*emphasis*
+
+**strong**
+
+`text`
+
+``inline literal``
+
+http://docutils.sf.net/ 孤立的网址会自动生成链接
+
+显示为特定的文字的链接 `sohu <http://www.sohu.com>`_
+
+突出显示的
+    上面文字
+
+正常缩进
+
+    形成锻炼
+
+
+
+特殊模块
+============
+
+选项会自动识别
+
+-v           An option
+-o file      Same with value
+--delta      A long option
+--delta=len  Same with value
+
+
+图片
+
+.. image:: ../figures/procedures.PNG
+    :height: 200
+    :width: 560
+    :scale: 50
+    :alt: alternate text
+    :align: center
+
+显示一个冒号的代码块::
+
+    中间要空一行
+
+::
+
+    不显示冒号的代码块
+
+.. code-block:: python
+    :linenos:
+    :emphasize-lines: 1,3
+
+    print("专业的代码块")
+    print("")
+    print("有行号和高亮")
+
+数学块
+
+.. math::
+
+    H_2O + Na = NaOH + H_2 \uparrow
+
+
+各种连接
+===========
+
+:doc:`/user/with_fitlog.rst`
+
+:mod:`~fastNLP.core.batch`
+
+:class:`~fastNLP.Batch`
+
+~表示指显示最后一项
+
+:meth:`fastNLP.DataSet.apply`
+