帮助手册-用 Markdown 写 Sphinx

Sphinx 默认是使用reStructuredText(简称reST) 格式进行写作，喜欢Markdown格式可以使用Recommonmark插件来实现。

大部分情况，我们写普通的Markdown格式，如果需需要高级一些的用法，可以看看下面有没有想要的效果：

Markdown转reST

重要

Its a note! in markdown!

注解

Its a note! in markdown!

警告

Its a note! in markdown!

侧边栏用法

emphasis-lines:

highlights the lines.

linenos:

shows the line numbers as well.

caption:

shown at the top of the code block.

name:

may be referenced with :ref: later.

1
2
3
4
5

# 注释行
import System
System.run_emphasis_line
# code ........................ 很长的代码会自动产生 水平 scrollbar
System.exit!

数学公式

参考

• Recommonmark auto_structify

• sphinx-rtd-theme

• reStructuredText 格式说明