在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
时间: 2024-10-07 19:48:25

在Win7下使用sphinx-build建立开源软件文档的相关文章

Windows7下使用sphinx生成开源文档(原)

作者这里以osgearth文档为例,感觉这种生成文档的方式比较好,生成的html文档是支持搜索的,感谢开源工作者的奉献.赞一个 1. 下载并安装python for windows:https://www.python.org/downloads/windows/ 2.下载安装setup tools下载easy_stall.py 并运行https://pypi.python.org/pypi/setuptools#windows-7-or-graphical-install,可以找到window

win7下建立虚拟wifi

win7下建立虚拟wifi 标签(空格分隔): wifi 步骤 1. 打开cmd窗口 2. 承载网络模式已设置为允许 netsh wlan set hostednetwork mode=allow 3. 更改承载网络的 SSID 和 托管网络的用户密钥密码 netsh wlan set hostednetwork ssid=zxhy key=12345678 4. 打开"网络共享", 将本地网络共享给刚新建的无线网络 点击"本地连接"=>"属性&qu

Win7下VS2010使用STLPort .

STLport的下载地址 http://sourceforge.net/projects/stlport/ 下载后,解压出文件.我的目录是 D:\STLport-5.2.1 . 右键计算机,属性,高级系统设置,环境,系统变量,编辑Path变量,添加;C:\Program Files\Microsoft Visual Studio 10.0\VC\bin.(我的路径是这样,分号是分隔符),确定.. 然后在 C:\Program Files\Microsoft Visual Studio 10.0\

在win7下搭建cocos2d-x v3.2rc0开发环境(For Android)

cocos2d-x 是目前比较流行的游戏引擎,为大多游戏开发爱好者所喜爱, 因此,本文的目的在于教导新手如何在win7下建立cocos2dx开发环境, 截止本文,cocos2dx的最新版本为 v3.2rc0版,我将假设您的开发 环境中已包含VS2012/VS2013集成工具(该IDE下载安装比较简单, 没有安装的朋友可以到微软官方下载安装),有了该工具,接下便 开始我们的游戏环境搭建之旅吧... 首先,建立该开发环境需要以下工具: 1.Visual Studio 2012/2013(微软IDE开

在win7 下编译MySQL源码

MySQL MySQL是一款优秀的开源数据库,在阿里.网易等各个互联网公司中有着广泛的应用.尽管各种NoSQL大行其道,但是关系型数据库依然必不可少. 作为一个新手,在Win7下用源码安装MySql数据库并不容易.我自己都折腾了好几天.今天把安装过程记录下来,其一是为了方便自己以后学习,其二则是分享过程,让学习者能够从我这篇文章中受益. 1. 编译环境及源码下载 编译环境:Visual Studio 2010 (Win7 32位) 编译工具: bison-2.4.1-setup.exe 下载地址

Win7下MongoDB的安装和使用

Win7下MongoDB的安装和使用 1.下载: http://www.mongodb.org/downloads 2.安装: 安装目录为 D:\mongodb\MongoDB 2.6 Standard 配置环境变量Path为 D:\mongodb\MongoDB 2.6 Standard\bin D:\mongodb\ 下建立一个data文件夹用于存放数据库文件 3.启动服务器: cmd下输入 mongod.exe --dbpath d:\mongodb\data 如果启动正常会看到类似如下的

Win7下搭建安卓android开发环境

本文出自 "孤狼" 博客,请务必保留此出处http://332374363.blog.51cto.com/5262696/1310882 另外,在搭建android开发环境时,还参考了http://www.apkbus.com/android-641-1-1.html 参考了:http://wenku.baidu.com/view/6108ac19b7360b4c2f3f6406.html 一.假设你现在什么都没有,那么你需要下载以下的东西: 1.JDK(JavaDevelopment

Win7下通过easyBCD引导安装Ubuntu14.04

Ubuntu14.04作为目前最新版本的ubuntu系统,相信很多人都想在自己的电脑上安装一下,然而系统的安装方法各式各样,u盘法.grub引导法等等,这里我将介绍在win7系统下用easyBCD软件建立引导,然后安装ubuntu的方法,这就不需要制作u盘启动盘那么麻烦,只需配置一些引导文件即可. 工具/原料 win7系统 ubuntu14.04系统镜像文件 easyBCD 2.2 DAEMON tools(非必须) 安装系统的前期准备 1 在网上下载ubuntu-14.04-desktop-a

win7下oracle的安装

1.参考地址1:http://www.cnblogs.com/libiao/archive/2008/08/24/1275000.html 2.参考地址2:http://www.server110.com/oracle/201310/2546.html 安装前先看看oracle的安装教程.例子.避免反复安装失败,大型工具的安装,第一次失败严重导致重装系统才行- 如下是我的安装过程中出现的问题和解决问题的一些步骤.以此记录,希望能惠及大家! 问题①:如下图所示,在这个步骤当中创建数据库失败.也就是