文档利器reStructuredText 工具

关于为啥要用reStructuredText，这个不用多说，方便，简洁。单从Python和Django的官网文档就是用reStructuredText来编写的，就可以看出这是一把利器。 reStructuredText（简写rst）能够转换的格式很多，包括html、xml、pdf及Latex等。一开始在windows下使用rst来编写，采用vim编辑器，可以装一个rst的插件vst.vim，可以提供语法高亮等功能。但是使用：Vst html转换成html文件，格式不够漂亮，后来网上搜到sphinx，能够生成格式漂亮的html。于是转到ubuntu下，使用sphinx。关于rst的编写规范，网上资料挺多，可以参考 http://wiki.venj.me/restructuredtext-quick-reference#jieshi 编写一个简单的rst文件，示例如下。
文章图片

ubuntu下使用sphinx，只需要安装python-sphinx包即可 root@archer:/home/archer# apt-get install python-sphinx 安装后，就可以使用sphinx-quickstart命令来使用了，先建一个目录，然后进入目录执行sphinx-quickstart（注意要root权限） root@archer:/home/archer# mkdir use_rst root@archer:/home/archer# cd use_rst root@archer:/home/archer/use_rst# sphinx-quickstart 执行过程中会让设置一些东西，只管一路enter，遇到Project Name、Author Name(s)、Project Version、Project Release时自己填一下
文章图片

执行完后目录下生成一些文件

文章图片

然后make html root@archer:/home/archer/use_rst# make html 执行成功后在_build/html下生成了对应的html文件，使用浏览器访问可以看到效果。
文章图片

文档利器reStructuredText

推荐阅读

榴莲放塑料袋里放一夜会坏吗

山鲁佐德是什么东东

isupper函数头文件，为什么这个程序中isupper函数不需要头文件ctypeh

微信欢乐斗地主残局闯关困难第72关怎么过 72关通关破解技巧

抖音拉面滑溜溜魔性游戏下载地址介绍

银行在为客户开通手机银行时，收费吗？开通电话银行要钱吗

2017年3月6日

跟踪对焦怎么用

威士忌水货和行货的区别

盘点皮革包的保养重点

喜欢闻汽油味正常吗为什么喜欢闻汽油味正常吗

干虾米要泡多久才可以吃干虾米要泡多久

哪种消防器材不适宜家庭单独配用

ios 教程，如何玩转苹果ios系统

跟这杯水无关

如何安装dns服务器

大肠|皮肤差有口臭多是因为肠内有宿便？都不是大肠的锅

博世洗衣机开机跳闸怎么办,这个是由于什么造成的

U盘文件没删除却消失了怎么解决？

实习期能上高速吗