文檔利器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文件,使用瀏覽器訪問可以看到效果。

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章