内容简介：Sphinx(没错，就叫斯芬克斯。。。)其实是一个基于SQL全文检索引擎，大概是个为数据库检索提供一些更加强大的检索功能。这个东西也给很多种的语言比如PHP,Python,Perl,Ruby留有API接口，可以供他们调用实现检索功能。当然，暂时我还没打算研究这个东西。今天我只是想利用他给Python的接口来为python程序生成基于网页形式的项目文档。（好像国外挺流行这个的，今天就是为了给deep learning的源码生成下文档才晓得有这个东西的）。目测这潭水还是很深的，今天姑且就事论事，把实现的步骤简
Sphinx(没错，就叫斯芬克斯。。。)其实是一个基于 SQL 全文检索引擎，大概是个为数据库检索提供一些更加强大的检索功能。这个东西也给很多种的语言比如PHP,Python,Perl,Ruby留有API接口，可以供他们调用实现检索功能。
当然，暂时我还没打算研究这个东西。今天我只是想利用他给 Python 的接口来为python程序生成基于网页形式的项目文档。（好像国外挺流行这个的，今天就是为了给deep learning的源码生成下文档才晓得有这个东西的）。
目测这潭水还是很深的，今天姑且就事论事，把实现的步骤简要记录下来方便日后使用。
安装
由于是为了在python下使用了，当然使用python的下载工具pip来安装了，pip的使用方法见《pip工具简单用法》。
安装命令：
$pip install sphinx
so easy就装好了，接下来就是用他来生成文档了。
生成
对于那些本身就为Sphinx设计过的工程来说，可以直接找到他的doc/目录，如果发现了conf.py文件的话，说明他已经预先做了配置。这时候我们只需要直接生成apidoc就行了： $ sphinx-apidoc -o .doc/ .
然后在他的输出目录下就会出现一个Makefile，然后我们只要 $make html
，就会发现一个html文件夹，没错，我们的文档就在这里啦。
而对于那些没有配置过Sphinx的工程来说，我们首先得在他的.py文件的目录下进行预先生成： $sphinx-quickstart
然后根据提示输入文件名，作者名，版本号啥啥的，然后一路确认就可以了。这样就会生成一个conf.py的文件，然后进行之前的操作就好了。
以上这就是生成文档的最简单的用法。。。应该是一个 程序员 理所应当需要掌握的了。。。
以上所述就是小编给大家介绍的《利用Sphinx工具为python项目生成文档》，希望对大家有所帮助，如果大家有任何疑问请给我留言，小编会及时回复大家的。在此也非常感谢大家对 码农网 的支持！
猜你喜欢:
- 利用代码生成工具生成基于ABP框架的代码
- 利用styleSheets快速生成一个图标库界面
- 利用Django徒手写个静态页面生成工具
- 利用 Linux 系统生成随机密码的 10 种方法
- 利用云开发优化博客小程序（三）——生成海报功能
- 【Mysql进阶技巧(2)】利用mysql生成唯一序号
本站部分资源来源于网络，本站转载出于传递更多信息之目的，版权归原作者或者来源机构所有，如转载稿涉及版权问题，请联系我们。
