为什么使用reStructuredText

经过仔细研究和比较，我终于从reStructuredText, Markdown, Wiki和Docbook中选择了reStructedText作为主要的写文档的工具。原因是：

reStructuredText(简称为rst)是一个WYSIWYG的plain text文本格式。因此rst与docbook比较,易于书写和阅读。
和同样是WYSIWYG的Markdown相比，rst支持工具更加丰富一些。并且rst还在不停的演变和发展，支持的功能更多一些，例如公式和网站发布。
rst是python用以书写文档的工具。详细信息可以从http://docutils.sourceforge.net/rst.html获得。官方使用docutils来转换rst文档。

docutils在win32环境下使用有些别扭，要求在docutils/tools路径下执行转换命令：

python rst2html.py <source_file> <html_file>

可以用rst2latex.py转换为latex文档，然后使用pdflatex转换为pdf格式。

如果使用vim来编辑rst文档，一个plugin vst 可以很好的帮助大家。

内容转自:http://blog.sina.com.cn/s/blog_53e7a2e5010009mp.html

转载于:https://my.oschina.net/asbamboo/blog/3027390

为什么使用reStructuredText相关推荐

Windows下配置sphinx+reStructuredText详解
最近有朋友想在windows下做个人笔记,没有找到顺手的工具,问我有什么好的工具推荐.正好前两天在网上看到一款做文档的利器sphinx+reStructText,当时在ubuntu下搭了下环境试了试, ...
reStructuredText(.rst)语法规则快速入门
原文:http://blog.useasp.net/archive/2014/09/05/rst-file-restructuredtext-markup-syntax-quikstart.aspx? ...
reStructuredText学习
reStructuredText学习 ==================== 2015年4月1日学习的最好方法就是尽快动手开始.不断迭代,不断完善. reStructuredText学习v0.1版 ...
datetimepicker中文不生效_Python reStructuredText 帮助文件中文乱码
在使用 IntelliJ 对 reStructuredText 文件进行编辑的时候. 我们可能会遇到乱码的情况. 如下图: python-encode-011290×604 72.6 KB 可以看到, ...
听说reStructuredText不错
看了一位大牛写的文章 http://yuanboshe.github.io/blog/2013-10-select_personal_websit_solution.html 深有感触,感觉自己编辑文 ...
reStructuredText 初学者语法汇总
文档格式编辑,目前主流最强大的是LaTeX,但是语法太复杂,环境要求也多,有的时候也是写文档往往选择 Markdown.常常怀疑文档编辑的Markdown不是亲生的, 很多功能不全,而且各个的厂家的语 ...
reStructuredText语法规则（官方的）
摘自:https://zh-sphinx-doc.readthedocs.io/en/latest/rest.html#id48 http://www.pythondoc.com/sphinx/con ...
pycharm 修改默认的注释风格（reStructuredText风格、Google风格、Numpy风格）
位置是:Preferences | Tools | Python Integrated Tools 也可以在设置中直接搜索:Docstring format
reStructuredText
段落段落必须由空行代替段落1段落2 内联标记 *斜体***粗体**``代码块`` 列表有序列表列表的格式是列表符号(星号,编号.,#.)加一个空格. 子列表需要和父列表分行并且缩进两个空格 1 ...

为什么使用reStructuredText

为什么使用reStructuredText相关推荐

最新文章

热门文章