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,可以找到windows
7的下载地址

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

    •   easy_install可以自动下载并安装sphinx以及它所依赖的其他模块。

4.安装完成后,命令行会提示Finished Processing dependencies for shinx

5.在命令行输入sphinx-build,如果在安装python时,没有设置环境变量,可能会弹出sphinx-build不是内部或者外部命令。

6.添加环境变量,将python目录下的scripts加入到环境变量的path中。再次执行会有相关信息。不用管这些,重要的是sphinx-build可用

7.找到下载的docs文档目录,如下图所示,build是我自己添加了,默认只有其他几个文件及文件夹

8.打开控制台程序,cd到该目录下。执行make html。

9.然后等待。。。

10.然后在build/html文件夹下,可以看到你想看到的html文件,打开index.html

附:怎么制作自己的文档可以参见3,

参考文档:

1.http://www.cnblogs.com/Lvkun/archive/2010/04/01/1702245.html

2.http://ericscottbarr.com/blog/2012/03/sphinx-and-cmake-beautiful-documentation-for-c-projects/

3.http://avnpc.com/pages/writing-best-documentation-by-sphinx-github-readthedocs

4.http://www.ibm.com/developerworks/cn/opensource/os-sphinx-documentation/

5.http://www.pythondoc.com/sphinx/

Windows7下使用sphinx生成开源文档(原),布布扣,bubuko.com

时间: 2024-10-02 23:25:54

Windows7下使用sphinx生成开源文档(原)的相关文章

Asp.Net Core下使用swagger生成api文档

目录 一.前期准备 二.配置Swagger 三.参考 .Net Core中有两个集成NSwag的包,分别为Swashbuckle和NSwag.两者的配置大同小异.这里以NSwag为例. 一.前期准备 1.初始化asp.net core 测试项目 新建asp.net core项目,此处略过: 新建apicontroller,并编写测试代码: [Route("api/[controller]")] [ApiController] public class UserApiController

#sphinx#生成html文档

最近研究eventlet的资料,打开了官网文档(http://eventlet.net/doc/)但是不见得有下载.无奈windows安装sphinx无力... 于是跑去github找这个项目,因为windows上没安装git,只好下载项目的源码包,打开其doc目录 可以看到里面的Makefile 我干脆把它发到虚拟机中的xubuntu,使用如下命令安装sphinx: apt-get install python-sphinx 在doc目录中,输入: make html 会生成一个_build目

使用freemarker模板引擎生成word文档的开发步骤

1.准备模板文档,如果word文档中有表格,只保留表头和第一行数据:2.定义变量,将word文档中的变量用${var_name}替换:3.生成xml文件,将替换变量符后的word文档另存为xml文件:4.格式化xml文件,使用工具(XmlFormat.exe),自动生成格式化后的xml文件:5.美化xml文件,${}中的内容仅保留变量名:6.表格,将表格中的行数据用相应的变量替换,在第一行数据的收尾加标签:<#list tbl1 as tbl1></#list> ,注意:表格可嵌套

利用sphinx为python项目生成API文档

sphinx可以根据python的注释生成可以查找的api文档,简单记录了下步骤 1:安装 pip install -U Sphinx 2:在需要生成文档的.py文件目录下执行sphinx-apidoc -F -o ./doc ./domain/model/ 在当前目录下新建doc目录,api文档的文件夹就在此目录下,./domain/model/ 表示需要生成api文档的目录. 3:进入doc目录 修改conf.py文件 设置代码路径为sys.path.insert(0, os.path.ab

使用POI生成具有三级下拉菜单的Excel文档

曾在工作中遇到这种需求,研究很久编码出一个方法,提供于此供大家参考. 效果图如下: 开始贴代码,代码中部分测试数据不影响功能. 第一部分(核心处理): 此部分包含几个方面: 获取三级下拉框各列的数据: 创建每个下拉功能的名称管理器 在隐藏的sheet中生成下拉菜单所需要的row 代码如下: /** * 第一部分 * 将三个列表所有字段从数据库查询出,并生成名称管理器,存放至隐藏的sheet中 */ private static HSSFWorkbook writePorpData() { int

拯救你的文档 – 【DevOps敏捷开发动手实验】开源文档发布

今天上海的天气真是不错,风和日丽.再次来到微软上海紫竹研发中心,心情很是愉快,喜欢这里的大草坪,喜欢这里的工程气氛,更喜欢今天来陪我的小伙伴们. 这次动手实验培训与以往最大的不同就是采用了开源文档的方式.其实,小编一直在寻找一种更好的技术文档编写方式.说到文档,我在过去的几年中也写了不下500份不同类型的文档.我估计,每个写过技术文档的同学都有类似这样的文件夹. 是不是很有一种蛋疼的感觉,没有办法啊,需求改来改去,客户的要求变来变去 … … 最后么,就没有最后了,你就自己苦逼去吧. 所以,自从开

使用PHP生成PDF文档

原文:使用PHP生成PDF文档 实际工作中,我们要使用PHP动态的创建PDF文档,目前有许多开源的PHP创建PDF的类库,今天我给大家来介绍一款优秀的PDF库,它就是TCPDF,TCPDF是一个用于快速生成PDF文件的PHP5函数包.TCPDF基于FPDF进行扩展和改进,增强了实用功能. 使用PHP生成PDF文档 实际工作中,我们要使用PHP动态的创建PDF文档,目前有许多开源的PHP创建PDF的类库,今天我给大家来介绍一款优秀的PDF库,它就是TCPDF,TCPDF是一个用于快速生成PDF文件

Python sphinx-build在Windows系统中生成Html文档

看到前同事发布的"Markdown/reST 文档发布流水线"基于TFS.Docker.Azure等工具和平台进行文档发布的介绍说明,不得不在心中暗暗竖起大拇指.这套模式,实现了文档编写后版本管理.发布.存档.分享的高度自动化,它不仅仅可以应用在文章中介绍的技术文档发布模式,同样也适用于我们大多数web.app等软件生命周期过程模式.DevOps一词的盛行,绝对不是软件行业中又一个流行语的鼓吹和炒作,而是软件过程的一种发展和进化.结合自动化平台.Docker.云平台等优秀技术和产品.软

使用doxygen、graphviz生成OpenSceneGraph文档

OpenSceneGraph是一款开源的c++三维引擎库,不过因为是开源,所以相关文档十分稀缺.虽然官网提供的源码可以直接生成doxygen文档,不过貌似不太好用,反正我是没有正确生成. 自己研究了一下用doxygen.graphviz生成OpenSceneGraph文档,并且最终成功生成相关文档,把过程整理一下,希望对大家有所帮助. 原料: doxygen-1.8.11-setup.graphviz-2.38, 这两款软件都是开源的,下载地址分别是: http://ftp.stack.nl/p