reStructuredText学习笔记

• 网站是基于 reStructuredText 书写，参考帮助链接：

  • 中文链接1:
    http://zh-sphinx-doc.readthedocs.io/en/latest/rest.html

  • 中文链接2:
    http://sphinx-doc-zh.readthedocs.io/en/latest/contents.html

  • 英文链接3:
    http://www.sphinx-doc.org/en/master/

标题

代码书写如下 ::

一级标题
####################

二级标题
********************

三级标题
=====================

备注： 标题下面的特殊字符要远远长于标题，另外标题是自动编号的，不需要在标题加数字和字符

斜体

代码如下 ::

*在我前后加上单星号我就是斜体了*

备注：对一行文字中的个别文字斜体，请在单星号前后各加空格与普通文本进行区别

加粗

代码如下 ::

**在我前后加上双星号我就是加粗了**

备注：假如对一行文字中的个别文字加粗，请在双星号前后各加空格与普通文本进行区别

超链接

代码如下 ::

`<https://github.com/PacificBiosciences/PacBioFileFormats/wiki/BAM-recipes>`_

图片

代码如下 ::

.. image:: image/pacbio_assembly_micro.png
    :scale: 10 %
    :align: center

备注：插入的图片这里是相对路径不是绝对路径

简单代码高亮

代码如下 ::

``我是文字前后是我的语法``

大段代码高亮

代码如下 ::

下一段是代码文字 ::
    
    代码部分

备注：使用方法就是在要高亮的代码前使用 :: ，然后将需要高亮的部分缩进，高亮部分的前后都要有空行

文档更新时间设置

代码如下 ::

本文档的最后更新时间为 |today| 请在我前后加个空格

建立下载链接文件

代码如下::

这是我要下载的文件  :download:`16s_report.wmv <../../train/16s_report.wmv>`