zoukankan      html  css  js  c++  java
  • 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.8docs,现在将docs内容转换成html格式,并在docs中建立build目录,转换后的html存放目录,执行命令:

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

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

    1.下载并安装Docutilshttp://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 设置成包含中文的路径,否则容易出现一些默名其妙的错误,例如编码错误。)

  • 相关阅读:
    理解inode
    贝叶斯公式与拼写检查器
    《C程序设计语言》第四章 函数和程序结构
    MIT《计算机科学与编程导论》课堂笔记
    很牛的牛顿迭代法
    开发一个小工具重温C#经典问题
    斯坦福《编程方法学》环境搭建及常见问题
    看Sybase官方手册学索引工作原理
    学习编程的方法、软件和工具
    大师里奇留给了我们什么
  • 原文地址:https://www.cnblogs.com/ListenWind/p/4422640.html
Copyright © 2011-2022 走看看