zoukankan      html  css  js  c++  java
  • 在Win7下使用sphinx-build建立开源软件文档

    最近想看看odoo的使用文档,在线看不方便,而且还没有提供离线文档下载,由于是开源项目,此项目托管在Github上,于是就有了想通过Github把文档git下来,可是git下来的文档是.rst文件,无法正常阅读。查看资料,弄明白了,需要通过sphinx来转换成需要的格式。

    下面就开始我的转换过程

    1、安装Python2.7.10(下载并安装python for windows:https://www.python.org/downloads/windows/)

    2、安装完成后,在python的scripts目录下,应该可以找到easy_install,在CMD控制台下执行该命令在命令行输入easy_install sphinx

      •   注:easy_install可以自动下载并安装sphinx以及它所依赖的其他模块。
      • 3、安装完成后,命令行会提示Finished Processing dependencies for shinx
      • 4、在命令行输入sphinx-build --version,可能会弹出sphinx-build不是内部或者外部命令。 在安装python时,没有设置环境变量。添加环境变量,将python目录下的scripts加入到环境变量的path中。再次执  行sphinx-build --version会有相关版本信息。说明sphinx-build可用 
      • 5、在命令行下,CD到需要转换的文档目录下,并运行sphinx-build trunk html 如图:
      • 6、等待片刻,就会在当前目录下生成一个html文件夹。这就是这个文档的html格式的手册。
      • 参考:
      • http://www.cnblogs.com/huangjacky/archive/2012/07/15/2592671.html
      • http://www.cnblogs.com/yanhuiw/p/3756085.html
  • 相关阅读:
    WCF+EntityFramework+mysql总结
    实现Win7远程桌面关机和重启
    EF 4.1 一些操作
    Ado.net利用反射执行SQL得到实体
    .net IL 指令速查
    VS2010 /VC/bin/rcdll.dll 无法找到资源编译器
    Win7下 httpRequest带证书请求https网站
    VS2010 自动关闭的问题解决方法
    Android 之 悬浮窗口
    论 Java 中获取一组不重复的随机数之性能问题
  • 原文地址:https://www.cnblogs.com/SunOne/p/4991045.html
Copyright © 2011-2022 走看看