sphinx

在使用python中，我们一般在模块，类，函数下使用docstring添加字符串说明性文档，使开发人员更好的可以看懂此代码是做什么用的。然而写了那么多的注释，我们想要一篇文档怎么办，第一种办法不可能将写完的注释直接手动的ctrl+c ctrl+v的，此时sphinx就出现了，解决了这一问题。 要想使用它，首先得需要安装它，安装方式： pip install sphinx 安装完成之后，在主项目下创建docs文档 #创建完docs项目并切换到 docx目录下 cd docx 在 docx下运行 sphinx-quickstart 之后会提示让对项目进行一些设置，以生成项目的配置文件，下面是一个推荐的配置： > Root path for the documentation [.]: doc # 在当前目录下新建doc文件夹存放sphinx相关信息 > Separate source and build directories (y/n) [n]: # 默认，直接回车 > Name prefix for templates and static dir [_]: > Project name: python123 # 输入项目名称 > Author name(s): 123 # 作者 > Project version: 1.0 # 项目版本 > Project release [1

sphinx简介 sphinx是一种基于Python的文档工具，它可以令人轻松的撰写出清晰且优美的文档，由Georg Brandl在BSD许可证下开发。新版的Python3文档就是由sphinx生成的，并且它已成为Python项目首选的文档工具，同时它对C/C++项目也有很好的支持。更多详细特性请参考spinx官方文档，本篇博客主要介绍如何快速为你的Python注释生成API文档。 环境 需要安装python 安装sphinx pip install sphinx 1 实例 新建一个项目 目录结构如上图所示，doc目录使用来存放API文档，src目录是用来存放项目的源码。 src目录下的源码 #coding=UTF-8 class Demo1(): """类的功能说明""" def add(self,a,b): """两个数字相加，并返回结果""" return a+b def google_style(arg1, arg2): """函数功能. 函数功能说明. Args: arg1 (int): arg1的参数说明 arg2 (str): arg2的参数说明 Returns: bool: 返回值说明 """ return True def numpy_style(arg1, arg2): """函数功能. 函数功能说明. Parameters ---------- arg1 :

sphinx的配置文件是在配置的时候最容易出错的了： 基本概念： source：数据源，数据是从什么地方来的。 index：索引，当有数据源之后，从数据源处构建索引。索引实际上就是相当于一个字典检索。有了整本字典内容以后，才会有字典检索。 searchd：提供搜索查询服务。它一般是以deamon的形式运行在后台的。 indexer：构建索引的服务。当要重新构建索引的时候，就是调用indexer这个命令。 attr：属性，属性是存在索引中的，它不进行全文索引，但是可以用于过滤和排序。 sphinx的配置文件过于冗长，我们把sphinx默认的配置文件中的注释部分去掉，重新进行描述理解，就成下面的样子了： ## 数据源src1 source src1 { ## 说明数据源的类型。数据源的类型可以是：mysql，pgsql，mssql，xmlpipe，odbc，python ## 有人会奇怪，python是一种语言怎么可以成为数据源呢？ ## python作为一种语言，可以操作任意其他的数据来源来获取数据，更多数据请看：（http://www.coreseek.cn/products-install/python/） type = mysql ## 下面是sql数据库特有的端口，用户名，密码，数据库名等。 sql_host = localhost sql_user = test sql

1、下载sphinx源码包 　　　　　　 　　　 上面截图的这个网址 复制链接地址 在putty终端使用： wget http://sphinxsearch.com/files/sphinx-2.3.1-beta.tar.gz 　　　注：一般都下载到/usr/local/src目录下 　　　　　安装一般都安装到/usr/local/sphinx ( sphinx这个目录是自定义的 ) 　　在此目录使用tar命令解压 ：tar zxvf sphinx-2.3.1-beta.tar.gz 2、开始进行编译 注：源代码安装肯定得安装gcc,安装工具包 　　安装工具包命令：yum -y install make gcc g++ gcc-c++ libtool autoconf automake imake mysql-devel libxml2-devel expat-devel 注： （ yum -y 就是不用确定进行安装，不能少装 ）安装完成不报错就可以进行编译 　　安装命令：./configure --prefix=/usr/local/sphinx （--prefix=安装目录） 　　安装完成后会告诉你可以进行编译，欢迎使用sphinx 3、make 生成编译文件不会进行编译 　 make install 进行编译 //警告忽略 　也可以一起执行：make && make

sphinx是国外的一款搜索软件。 coreseek是在sphinx的基础上，增加了中文分词功能，换句话说，就是支持了中文。 Coreseek发布了3.2.14版本和4.1版本，其中的3.2.14版本是2010年发布的，它是基于Sphinx0.9.9搜索引擎的。而4.1版本是2011年发布的，它是基于Sphinx2.0.2的。Sphinx从0.9.9到2.0.2还是有改变了很多的，有很多功能，比如sql_attr_string等是在0.9.9上面不能使用的。 可以同时安装sphinx，coreseek，不会互相冲突。 环境：centos6.5 + mysql5.6 + other。 首先安装sphinx： 1. 下载安装包 http://sphinxsearch.com/downloads/ (目前最新版本是2.2.10) 2 ./configure --prefix=/usr/local/sphinx --with-mysql=/usr/local/mysql (mysql其实不用指定，默认已经支持) make && make install 3.安装完成后，在 /usr/local/sphinx目录下会有4个目录 4.打开example.sql ，执行上面的sql.这是测试用例。 5.进入etc目录，拷贝配置文件， cp sphinx-min.conf.dist sphinx