Sphinx是一种
Python社区编写和使用的文档生成器,也可在其他环境中使用,它是一种全文检索引擎。
Sphinx是一个基于
SQL的全文检索引擎,可以结合
MySQL,
PostgreSQL做全文搜索,它可以提供比数据库本身更专业的搜索功能,使得应用程序更容易实现专业化的全文检索。Sphinx特别为一些脚本语言设计搜索API接口,如
PHP, Python,
Perl,
Ruby等,同时为MySQL也设计了一个存储引擎
插件。此外,Sphinx是用
Python编写的,它将reStructuredText文件转换为
HTML网站和其他格式,如PDF、EPUB、Texinfo和man,广泛应用于Python项目的文档开发。
Sphinx于2008年3月21日发布了第一个公共版本0.1.61611。它不仅被广泛应用于
Python项目的文档开发,如Bazaar、
SQLAlchemy、MayaVi、SageMath、
SciPy、
Django和Pylons,还用于Blender用户手册和Python API文档。
2010年,Eric Holscher宣布创建Read the Docs项目,作为使软件文档维护更容易的努力的一部分,该项目可以在每次提交之后自动构建和上传Sphinx文档。