You can not select more than 25 topics Topics must start with a chinese character,a letter or number, can include dashes ('-') and can be up to 35 characters long.

example.rst 1.4 kB

6 years ago
6 years ago
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104
  1. ======
  2. 大标题
  3. ======
  4. .. note::
  5. 中文标题需要符号的数量至少是中文字数的两倍
  6. .. warning::
  7. 符号的数量只可以多,不可以少。
  8. 小标题1
  9. ###########
  10. 小标题2
  11. *********
  12. 小标题3(正常使用)
  13. ========================
  14. 小标题4
  15. -------------------
  16. 参考 http://docutils.sourceforge.net/docs/user/rst/quickref.html
  17. 常见语法
  18. ============
  19. *emphasis*
  20. **strong**
  21. `text`
  22. ``inline literal``
  23. http://docutils.sf.net/ 孤立的网址会自动生成链接
  24. 显示为特定的文字的链接 `sohu <http://www.sohu.com>`_
  25. 突出显示的
  26. 上面文字
  27. 正常缩进
  28. 形成锻炼
  29. 特殊模块
  30. ============
  31. 选项会自动识别
  32. -v An option
  33. -o file Same with value
  34. --delta A long option
  35. --delta=len Same with value
  36. 图片
  37. .. image:: ../figures/procedures.PNG
  38. :height: 200
  39. :width: 560
  40. :scale: 50
  41. :alt: alternate text
  42. :align: center
  43. 显示一个冒号的代码块::
  44. 中间要空一行
  45. ::
  46. 不显示冒号的代码块
  47. .. code-block:: python
  48. :linenos:
  49. :emphasize-lines: 1,3
  50. print("专业的代码块")
  51. print("")
  52. print("有行号和高亮")
  53. 数学块
  54. .. math::
  55. H_2O + Na = NaOH + H_2 \uparrow
  56. 各种连接
  57. ===========
  58. :doc:`/user/with_fitlog`
  59. :mod:`~fastNLP.core.batch`
  60. :class:`~fastNLP.Batch`
  61. ~表示指显示最后一项
  62. :meth:`fastNLP.DataSet.apply`