Python 的 docutils 文檔如何進行編譯

docutils 的官方工具地址爲:https://docutils.sourceforge.io/html

目前的更新主要是在版本和使用手冊的更新上,由於 Python 使用 reStructuredText 文檔格式,那麼必不可少會用到 docutils 進行文檔生成。python

例如,咱們但願將 https://docutils.sourceforge.io/ 上的文檔生成成中文的手冊。ide

首先你須要將 https://docutils.sourceforge.io/ 上面的 SVN 原代碼下載到本地。工具

假設咱們的下載目錄是:C:\WorkDir\Ossez-Com\Python\Source-Code\docutilsui

那麼你須要在你的 Python 環境中運行 Python 命令:spa

(base) C:\WorkDir\Ossez-Com\Python\Source-Code\docutils\docutils>python tools/buildhtml.py --config=tools/docutils.conf

你能夠指定配置文件,也能夠不指定配置文件。orm

docutils-py-html-01

 

在你的 Python 環境中會有上面的輸出。cdn

而後進入目錄: C:\WorkDir\Ossez-Com\Python\Source-Code\docutils\docutils\docs\user 查看,你會看到對應 txt 的源文件已經生成爲 html 供你瀏覽了。htm

docutils-py-html-02

 

單擊一個你修改過的文件,而後查看,中文也可以比較好的支持。文檔

docutils-py-html-03

 

這個就是對 docutils 進行文件編輯的方法。你能夠直接修改 txt 文件,而後 Python 生成。

相關文章
相關標籤/搜索