2. rst 用法总结


2.1. 锚点链接

2.1.1. 内部链接

.. _link_text:

:ref:`点击链接<link_text>`

2.1.2. 外部链接

请访问 `孔令贤的csdn <http://blog.csdn.net/lynn_kong?viewmode=contents>`_ 所有博文

请访问 孔令贤的csdn 所有博文

2.2. 代码相关

  • 普通代码定义:
::

    import sys
    from mod import main
    if __name__ == "__main__":
        sys.exit(main())

效果:

import sys
from mod import main
if __name__ == "__main__":
    sys.exit(main())
  • 高亮代码定义,带行号:
.. code-block:: python|console
    :linenos:

    import sys
    from mod import main
    if __name__ == "__main__":
        sys.exit(main())

效果:

1
2
3
4
import sys
from mod import main
if __name__ == "__main__":
    sys.exit(main())
  • 高亮代码定义2:
import sys
from mod import main
if __name__ == "__main__":
    sys.exit(main())
  • 引用代码文件:
.. literalinclude:: /_static/src/test_cfg.py
    :language: python
    :linenos:

2.3. 引用图片

.. figure:: /_static/images/kvm_error.png
   :scale: 100
   :align: center

   KVM启动虚拟机错误

2.4. 注释

..
    这是注释
    这也是注释

2.5. 目录

.. contents:: 目录

----------------------

2.6. 层次结构

一般来说,四级标题就足够使用了。

标题
#############

标题1
============

标题2
+++++++++

标题3
-------------

标题四
^^^^^^^^^^^

2.7. 列表

无序列表

- 首先
- 其次

  * 嵌套1
  * 嵌套2

- 再次

效果:

  • 首先
  • 其次
    • 嵌套1
    • 嵌套2
  • 再次

有序列表

#. 首先
#. 其次

   * 嵌套1
   * 嵌套2
#. 再次

效果:

  1. 首先
  2. 其次
    • 嵌套1
    • 嵌套2
  3. 再次

2.8. 其他

  • setFormatter() selects a Formatter object for this handler to use.
logging.Formatter.__init__(fmt=None, datefmt=None)

If there is no message format string, the default is to use the raw message. If there is no date format string, the default date format is:

%Y-%m-%d %H:%M:%S

Today’s date is 2018-05-21.