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 生成。

相关文章
相关标签/搜索