Sphinx编译docs文档

在使用Python、Django的过程中，经常看到docs目录，里面存放着一些txt文本文件，也就是自带的一些帮助文档，里面有make.bat，在dos目录下直接执行make，给出的帮助是可以转换成Html、PDF等文件形式，那么，怎么转换这些帮助文档呢？直接执行make html发现提示sphinx-build不是内部或外部命令，在网上下载了Sphinx，并安装，再次执行make html时发现还是提示不是内部或外部命令，最后发现，Sphinx安装后，并没有在Python安装目录中生成Sphinx的模块，而是直接在Sphinx的源目录下生成了一个build目录，直接在当前目录中安装了。

通过查找帮助，直接早dos环境进入sphinx源文件目录，在此目录下执行如下命令：

python sphinx-build.py -b html 需要转化文档的全路径转换后文档的全路径

例如：我的Sphinx源文件路径在C:\Sphinx-1.3.1，Django的docs路径在C:\Django-1.8\docs，现在将docs内容转换成html格式，并在docs中建立build目录，转换后的html存放目录，执行命令：

C:\Sphinx-1.3.1>python sphinx-build.py -b html C:\Django-1.8\docs C:\Django-1.8\docs\build，执行后，在build目录生成了django的帮助文档（Html格式的）。

下列是需要安装的第三方工具：

1.下载并安装Docutils：http://docutils.sf.net/。

2.下载并安装sphinx ：http://pypi.python.org/pypi/Sphinx/1.1。

Sphinx 是用来生成文档的，可以生成html、htmlhelp/chm、qthelp、devhelp、latex、man 等格式的文档。

3.在Widnows环境下，打开命令提示符，使用cd /d 命令将当前目录切换至Sphinx目录，运行命令：python sphinx-build.py -b html sourcedir builddir，其中，-b后面的字符串用于控制输出文档的格式，默认为html。sourcedir表示文档来源文件夹（一般就是包含conf.py文件的那个文件夹），builddir表示生成文档的目标文件夹。(注：在Windows环境下，请不要将sphinx文件夹、sourcedir 和builddir 设置成包含中文的路径，否则容易出现一些默名其妙的错误，例如编码错误。)

转载于:https://www.cnblogs.com/ListenWind/p/4422640.html

Sphinx编译docs文档相关推荐

使用 Sphinx 撰写技术文档并生成 PDF 总结
这几天准备编排部分翻译的书籍和文档,找了好些工具,最终定格在 Sphinx 上,并基于 ReadTheDocs 提供的 SaaS 服务进行分发和分享.本篇博客是对整个过程的一次记录和总结. 项目代码: ...
Read the Docs 文档管理
Read the Docs 文档管理 1. 遇见 2. 浅谈 3. 搭建 4. 创建 5. 执行 6. 换装 7. 更新 8. 兼容 9. 提交 10. 托管 1. 遇见最近几年经常可以看到官方说明 ...
sphinx 编码 php文档,用Sphinx编写技术文档
用Sphinx编写技术文档大家会发现,如果一个项目主要是用Python写的,其文档都很类似,比如:Python在线的HTML官方手册.这些项目的文档都来源于一个很不错的项目:Sphinx.这个Sph ...
FastAPI 自动生成的docs文档没法使用
FastAPI 自动生成的docs文档没法使用,当展开路径时候一直在转圈,具体就是这样这个是由于swagger-ui 3.30.1 中的bug导致,具体bug可以看这里我们可以通过在FastAPI ...
Sublime Text 4 编译 LaTeX文档后总是新打开一个 Sublime Text 4 的解决方法
Sublime Text是一个优秀的文本编辑器,我喜欢用它来编辑与编译LaTeX文档,用到的插件是LaTeXTools,网络上的配置方法很多,但有一个问题始终困扰着我,使我差点放弃这种TeX文档编辑方 ...
Google Docs Download - 快速批量下载 Google Docs 文档
Google Docs Download是Firefox 的 Greasemonkey 脚本,用来下载 Google Docs 文档,配合 DownThemAll 扩展,可实现批量下载 . 今天和 G ...
Sphinx+Read the Docs文档编辑器
建议Python3.6 官方虽然说支持python2.x 但是在 Python2.x下是安装不成功的(多次尝试之后发现是不成功的) Sphinx 将标记语言转化为html页面. 标记语言默认支持:re ...
webpack 编译stylus_webpack 文档更新日志（9.129.29）
久等了,本应上周五发的更新日志,现在才来.话不多说,开始正题. 英文篇内容更新 API loader 中移除了对 this.exec 的说明 module-methods 中新增了 webpack ...
webpack 编译stylus_webpack 文档更新日志（9.12-9.29）
久等了,本应上周五发的更新日志,现在才来.话不多说,开始正题. 英文篇内容更新 API loader 中移除了对 this.exec 的说明 module-methods 中新增了 webpack ...

Sphinx编译docs文档

Sphinx编译docs文档相关推荐

最新文章

热门文章