使用markdown来写作¶
rst很强大,But现在markdown更流行,如果你想在sphinx中使用markdown来写作也是可以的, sphinx也提供了组件recommonmark,具体参见sphinx-markdown 但是recommonmark只实现了基础版本的markdown语法
简介¶
参见
- markdown语法
- rst
- [rst][http://sphinx-doc-zh.readthedocs.io/en/latest/rest.html]
下面演示用法,你看到的是渲染后的结果了,具体源码参见示例
code¶
\`\`\`
code
\`\`\`
\`\`\`ipython
In [1]: import os
In [2]:
\`\`\`
结果
code
In [1]: import os
In [2]:
sas¶
hello
math¶
a = \`$ y=\sum_{i=1}^n g(x_i) $\`
a+b
\`\`\`math
(a + b)^2 = a^2 + 2ab + b^2
\`\`\`
结果
a = \( y=\sum_{i=1}^n g(x_i) \)
a+b
\[ (a + b)^2 = a^2 + 2ab + b^2\]
rst¶
\`\`\`eval_rst
.. todo::
some todo things
\`\`\`
\`\`\`eval_rst
.. note::
some todo things
\`\`\`
\`\`\`eval_rst
.. warning:: note the space between the directive and the text
\`\`\`
\`\`\`eval_rst
.. seealso:: This is a simple **seealso** note.
\`\`\`
结果:
待处理
some todo things
注解
some todo things
警告
note the space between the directive and the text
参见
This is a simple seealso note.
table¶
\`\`\`eval_rst
.. table:: Truth table for "not"
:widths: auto
===== =====
A not A
===== =====
False True
True False
===== =====
\`\`\`
结果
A | not A |
---|---|
False | True |
True | False |
脚注¶
\`\`\`eval_rst
Lorem ipsum [#f1]_ dolor sit amet ... [#f2]_
.. rubric:: Footnotes
.. [#f1] Text of the first footnote.
.. [#f2] Text of the second footnote.
\`\`\`
结果
Lorem ipsum [1] dolor sit amet ... [2]
Footnotes
[1] | Text of the first footnote. |
[2] | Text of the second footnote. |
引证¶
\`\`\`eval_rst
Lorem ipsum [Ref]_ dolor sit amet.
.. [Ref] Book or article reference, URL or whatever.
\`\`\`
Lorem ipsum [Ref] dolor sit amet.
[Ref] | Book or article reference, URL or whatever. |
image¶
![](https://www.baidu.com/img/bd_logo1.png)