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

目前的更新主要是在版本和使用手册的更新上,因为 Python 使用 reStructuredText 文档格式,那么必不可少会用到 docutils 进行文档生成。

例如,我们希望将 https://docutils.sourceforge.io/ 上的文档生成成中文的手册。

首先你需要将 https://docutils.sourceforge.io/ 上面的 SVN 原代码下载到本地。

假设我们的下载目录是:C:\WorkDir\Ossez-Com\Python\Source-Code\docutils

那么你需要在你的 Python 环境中运行 Python 命令:

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

你可以指定配置文件,也可以不指定配置文件。

Python 的 docutils 文档如何进行编译_第1张图片

 

在你的 Python 环境中会有上面的输出。

然后进入目录: C:\WorkDir\Ossez-Com\Python\Source-Code\docutils\docutils\docs\user 查看,你会看到对应 txt 的源文件已经生成为 html 供你浏览了。

Python 的 docutils 文档如何进行编译_第2张图片

 

单击一个你修改过的文件,然后查看,中文也能够比较好的支持。

Python 的 docutils 文档如何进行编译_第3张图片

 

这个就是对 docutils 进行文件编辑的方法。你可以直接修改 txt 文件,然后 Python 生成。