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 sphinxpip install sphinx_rtd_theme

编译 rst 文档

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

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

编译示例：

rst

rst 格式文档编译方案相关推荐

在线文档查看方案- 易度云查看
在线文档查看方案- 易度云查看引用:http://viewer.everydo.com/tech/#id16 系统总体组成总体组成图如下: 其中: 查看器包括8种,在浏览器上运行.如需定制,可以使 ...
如何操作 Office Open XML 格式文档
摘要: Office Open XML格式文件代替了早期的二进制Office系统文件.本文档向您介绍了包含在一个格式化文档中的组件以及展示这些文件功能的一些场景 . Frank Rice,微软公司适 ...
如何操作 Office Open XML 格式文档(转）
原文地址为: 如何操作 Office Open XML 格式文档(转) 摘要: Office Open XML格式文件代替了早期的二进制Office系统文件.本文档向您介绍了包含在一个格式化文档中的组 ...
服务器文件整理流程,制造过程数据文档管理系统方案
原标题:制造过程数据文档管理系统方案概述盖勒普智能制造生产过程数据文档管理系统方案 - 使用了全球领先的 Predator PDM™ 平台化无纸化现场信息推送核心技术盖勒普智能制造生产过程数据文 ...
php使用pdf2htmlex,转换 HTML 与 PDF 格式文档的神器
企业 Web 项目开发中经常会有生产 PDF 格式文档的需求,例如 PDF 账单下载,月末生成各种统计报表等等.我们要帮助企业实现自动化,也就是说无需人工干预,程序能够按需从 DB 中拿数据自主生成. ...
Java DOC 转换给 PDF 格式文档的代码
工作过程,把写代码过程经常用的代码片段备份一次,下面的代码段是关于Java DOC 转换给 PDF 格式文档的代码,应该对码农们有所用. import java.io.File; import jav ...
PoiDocxDemo【Android将表单数据生成Word文档的方案之二（基于Poi4.0.0），目前只能java生成】...
版权声明:本文为HaiyuKing原创文章,转载请注明出处! 前言这个是<PoiDemo[Android将表单数据生成Word文档的方案之二(基于Poi4.0.0)]>的扩展,上一篇是根 ...
Python批量处理lrmx格式文档内指定内容
Python批量处理lrmx格式文档内指定内容实现代码: import glob import random xing = [ '赵', '钱', '孙', '李', '周', '吴', '郑', ...
【学习笔记】Windows格式文档转换成Unix格式
[学习笔记]Windows格式文档转换成Unix格式我们有时候需要将文档格式从Windows格式转换成Unix格式,Windows下换行是\r\n,而Unix下换行是\n,所以只需要将文档中的\r去 ...