rst 格式文档编译方案

最近为开源仓库贡献了一些代码和文档，然而 rst 格式的文档却无法预览，甚至都很难找到一个可用的编译器。

---

不知什么时候，我发现从前我用过一个 GitHub 的开源工具，它提供了将 rst 文档编译成 html 的工具：ieflex/newretaildoc 。它使用 Python 语言开发，有机会我把它做成一个 Web 小工具。

我现在把使用方法汉化如下：

clone 仓库到本地

git clone https://github.com/ieflex/newretaildoc.git

newretaildoc
|- .git
|- docs
  |- ...
  ...
  |- create_html.bat
  |- make.bat
  |- index.rst  # 这些文件不要误删
  |- license.rst
  |- Makefile
  |- README.md

安装样式库

其实没必要开个新的虚拟环境，直接安装在 base 环境即可。

 pip install sphinx
 pip install sphinx_rtd_theme

编译 rst 文档

• 将需要编译的 rst 文档放入 docs 目录下
• 在 docs 目录下呼出 cmd，并激活 base 环境
• 命令行输入 create_html.bat 运行脚本。他会把当前目录下的所有 rst 文档全部编译
  

  

  
  编译完成的 html 文件在在 docs 目录的 _build/html 文件夹中，即可在浏览器预览编译结果。

编译示例：

rst

原文地址：https://www.jb51.cc/wenti/3282971.html

版权声明：本文内容由互联网用户自发贡献，该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容， 请发送邮件至 [e-mail] 举报，一经查实，本站将立刻删除。