Sphinx和rst在科研笔记和学术博客中的高效用法
什么是RST? reStructuredText 是扩展名为 .rst 的纯文本文件,含义为"重新构建的文本",也被简称为:RST 或 reST; 是 Python 编程语言的 Docutils 项目的一部分,Python Doc-SIG (Documentation Special Interest Group)。 该项目类似于 Java 的 JavaDoc 或 Perl 的 POD 项目。 Docutils 能够从 Python 程序中提取注释和信息,格式化成程序文档。 .rst 文件类似于.md(Markdown)文件,是轻量级标记语言的一种, 被设计为容易阅读和编写的纯文本,并且可以借助 Docutils 这样的程序进行文档处理, 可以方便地转换为 HTML , Latex, Markdown 等多种格式。 rst在标记功能上比md丰富太多了,而且在Sphinx的框架下可以非常方便地使用各种插件,来实现各种不同特定需求。 比如地学领域最常用的绘图和数据处理软件gmt,其开发团队现在已经开发了适用于Sphinx的插件 sphinx_gmt , 这个插件的功能就是可以直接在rst文件中进行绘图,类似于Sphinx内置的python绘图插件 .. plot:: 。 比如在rst文件中写入如下所示的文字,就可以直接自动根据你的gmt绘图命令将图片绘制好并嵌入到最终生成的html文件