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

摘要:
作者以osgear文档为例,觉得这种生成文档的方法更好。生成的html文档支持搜索。感谢开源工作人员的奉献精神。再次执行时会有相关信息。别担心。重要的是可以使用斯芬克斯模型。7.找到下载文档的目录,如下图所示。我自己添加了build,默认情况下只有几个其他文件和文件夹可用。8.打开控制台程序并将其刻录到此目录。

作者这里以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是我自己添加了,默认只有其他几个文件及文件夹

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

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

9.然后等待。。。

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

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

附:怎么制作自己的文档可以参见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生成开源文档(原)》仅用于学习参考。如对内容有疑问,请及时联系本站处理。

上篇spring aop实现拦截接口请求打印日志一篇文章教会你用Python抓取抖音app热点数据下篇

宿迁高防,2C2G15M,22元/月;香港BGP,2C5G5M,25元/月 雨云优惠码:MjYwNzM=

相关文章

人生苦短,我用python-- Day4

  导航目录                         1.装饰器   1.1 函数即变量   1.2 高阶函数   1.3 嵌套函数   1.4 高阶函数+嵌套函数 =>就能实现本节的函数装饰器功能 2.迭代器&生成器   2.1 列表生成式   2.2 生成器   2.3 斐波那契序列   2.4 生成器实力应用   2.5 迭代器...

Ubuntu 18.04升级matplotlib 3.5

背景 需要使用到matplotlib 3.5的新特性决定升级搜索pip源发现python 3.6最高支持matplotlib 3.2而matplotlib 3.5仅适配python 3.7+ 安装 一定不要尝试卸载18.04自带python 3.6否则系统会崩溃 sudo apt install python3.8 依赖 安装3.8包管理工具 sudo...

Python开发利器WingIDE破解方法

“工欲善其事,必先利其器。”刚开始接触Python的人大都用自带的LDLE,尽管它对于初学该语言非常有帮助,但许多开发人员更喜欢其它文本编辑器或集成开发环境。(IDEs)在此我不想展开阐述,Python 社区维护了一份Python 相关编辑器的清单, 涵盖了各种各样支持平台和软件许可协议。但是所给出的编辑器个人认为都不是很理想,一直想找一个类似于php的Z...

python爬虫+使用cookie登录豆瓣

2017-10-09 19:06:22 版权声明:本文为博主原创文章,未经博主允许不得转载。 前言:先获得cookie,然后自动登录豆瓣和新浪微博 系统环境: 64位win10系统,同时装python2.7和python3.6两个版本(本次使用python3.6),IDE为pycharm,浏览器为chorme,使用的python第三方库为requests...

Python获取当前代码行数

import os import sys def line_file_test(): print(sys._getframe().f_lineno) # 获取当前行号(行数) print(__file__) # 获得当前Python文件绝对路径 print(os.path...

第五章 Python 函数(一)

Python 函数 一、函数功能和特性   功能: 1. 函数是对实现对实现某一功能的代码的封装 2. 函数可以实现代码的复用,从而减少代码的重复编写   特性: 1. 函数可以接受任何数字或者任何类型的输入作为其参数 2. 函数也可以通过关键字 return 可以返回任何数字或者其他类型的结果 二、函数的定义和调用 我们通常可以对函数进行的操作有:定义函...