sphinxpython安装(如何使用sphinx生成Python第三方模块的文档)

1.如何使用sphinx生成Python第三方模块的文档

在使用Python的过程中,无疑我们经常需要下载安装第三方模块(如何安装:URL),而安装后我们必然会面临一个使用的问题,这时候我们需要阅读相关的文档。可是我们会发现下载的第三方模块目录的doc文件夹下只有一个conf.py文件和一些后缀为rst的文件,文档在哪里呢?

其实Python提供了专用的文档生成工具,有了这些工具就可以很方便地生成我们需要的文档了。本文就是介绍如何使用一些第三方工具(sphinx)来生成这些文档。

1.下载并安装Docutils:、htmlhelp/chm、qthelp、devhelp、latex、man 等格式的文档。

3.在Widnows环境下,打开命令提示符,使用cd /d 命令将当前目录切换至Sphinx目录,运行命令:python sphinx-build.py -b html sourcedir builddir,其中,-b后面的字符串用于控制输出文档的格式,默认为html。sourcedir表示文档来源文件夹(一般就是包含conf.py文件的那个文件夹),builddir表示生成文档的目标文件夹。(注:在Windows环境下,请不要将sphinx文件夹、sourcedir 和builddir 设置成包含中文的路径,否则容易出现一些默名其妙的错误,例如编码错误。)

2.sphinx 在 windows下到底怎么安装

一、关于SphinxSphinx 是一个在GPLv2 下发布的一个全文检索引擎,商业授权(例如, 嵌入到其他程序中)需要联系作者(Sphinxsearch.com)以获得商业授权。

一般而言,Sphinx是一个独立的搜索引擎,意图为其他应用提供高速、低空间占用、高结果相关度的全文搜索功能。Sphinx可以非常容易的与SQL数据库和脚本语言集成。

当前系统内置MySQL和PostgreSQL 数据库数据源的支持,也支持从标准输入读取特定格式的XML数据。通过修改源代码,用户可以自行增加新的数据源(例如:其他类型的DBMS的原生支持)。

搜索API支持PHP、Python、Perl、Rudy和Java,并且也可以用作MySQL存储引擎。搜索API非常简单,可以在若干个小时之内移植到新的语言上。

Sphinx特性:* 高速的建立索引(在当代CPU上,峰值性能可达到10MB/秒);* 高性能的搜索(在2–4GB的文本数据上,平均每次检索响应时间小于0.1秒);* 可处理海量数据(目前已知可以处理超过100GB的文本数据,在单一CPU的系统上可处理100M文档);* 提供了优秀的相关度算法,基于短语相似度和统计(BM25)的复合Ranking方法;* 支持分布式搜索;*提供文件的摘录生成;*可作为MySQL的存储引擎提供搜索服务;*支持布尔、短语、词语相似度等多种检索模式;*文档支持多个全文检索字段(最大不超过32个);*文档支持多个额外的属性信息(例如:分组信息,时间戳等);*停止词查询;*支持单一字节编码和UTF-8编码;*原生的MySQL支持(同时支持MyISAM和InnoDB);*原生的PostgreSQL支持.中文手册可以在这里获得(酷勤网备用下载地址:sphinx_doc_zhcn_0.9.pdf)。二、Sphinx在windows上的安装1.直接在找到最新的windows版本,我这里下的是Win32 release binaries with MySQL support,下载后解压在D:\sphinx目录下;2.在D:\sphinx\下新建一个data目录用来存放索引文件,一个log目录方日志文件,复制D:\sphinx\sphinx.conf.in到D:\sphinx\bin\sphinx.conf(注意修改文件名);3.修改D:\sphinx\bin\sphinx.conf,我这里列出需要修改的几个:type = mysql # 数据源,我这里是mysqlsql_host = localhost # 数据库服务器sql_user = root # 数据库用户名sql_pass = '' # 数据库密码sql_db = test # 数据库sql_port = 3306 # 数据库端口sql_query_pre = SET NAMES utf8 # 去掉此行前面的注释,如果你的数据库是uft8编码的index test1{# 放索引的目录path = D:/sphinx/data/# 编码charset_type = utf-8# 指定utf-8的编码表charset_table = 0..9, A..Z->a..z, _, a..z, U+410..U+42F->U+430..U+44F, U+430..U+44F# 简单分词,只支持0和1,如果要搜索中文,请指定为1ngram_len = 1# 需要分词的字符,如果要搜索中文,去掉前面的注释ngram_chars = U+3000..U+2FA1F}# index test1stemmed : test1# {# path = @CONFDIR@/data/test1stemmed# morphology = stem_en# }# 如果没有分布式索引,注释掉下面的内容# index dist1# {# 'distributed' index type MUST be specified# type = distributed# local index to be searched# there can be many local indexes configured# local = test1# local = test1stemmed# remote agent# multiple remote agents may be specified# syntax is 'hostname:port:index1,[index2[,。

]]# agent = localhost:3313:remote1# agent = localhost:3314:remote2,remote3# remote agent connection timeout, milliseconds# optional, default is 1000 ms, ie. 1 sec# agent_connect_timeout = 1000# remote agent query timeout, milliseconds# optional, default is 3000 ms, ie. 3 sec# agent_query_timeout = 3000# }# 搜索服务需要修改的部分searchd{# 日志log = D:/sphinx/log/searchd.log# PID file, searchd process ID file namepid_file = D:/sphinx/log/searchd.pid# windows下启动searchd服务一定要注释掉这个# seamless_rotate = 1}4.导入测试数据C:\Program Files\MySQL\MySQL Server 5.0\bin>mysql -uroot testindexer.exe –allSphinx 0.9.8-release (r1533)Copyright (c) 2001-2008, Andrew Aksyonoffusing config file './sphinx.conf'…indexing index 'test1′…collected 4 docs, 0.0 MBsorted 0.0 Mhits, 100.0% donetotal 4 docs, 193 bytestotal 0.101 sec, 1916.30 bytes/sec, 39.72 docs/secD:\sphinx\bin>6.搜索'test'试试D:\sphinx\bin>search.exe testSphinx 0.9.8-release (r1533)Copyright (c) 2001-2008, Andrew Aksyonoffusing config file './sphinx.conf'…index 'test1′: query 'test ': returned 3 matches of 3 total in 0.000 secdisplaying matches:1. document=1, weight=2, group_id=1, date_added=Wed Nov 26 14:58:59 2008id=1group_id=1group_id2=5date_added=2008-11-26 14:58:59title=test onecontent=this is my test document number one. also checking search withinphrases.2. document=2, weight=2, group_id=1, date_added=Wed Nov 26 14:58:59 2008id=2group_id=1group_id2=6date_added=2008-11-26 14:58:59title=test twocontent=this is my test 。

3.如何把外部文件导入sphinx

. 下载并安装python for windows: w.python.org/downloads/windows/2.下载安装setup tools下载easy_stall.py 并运行 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 shinx5.在命令行输入sphinx-build,如果在安装python时,没有设置环境变量,可能会弹出sphinx-build不是内部或者外部命令。 6.添加环境变量,将python目录下的scripts加入到环境变量的path中。

再次执行会有相关信息。不用管这些,重要的是sphinx-build可用7.找到下载的docs文档目录,如下图所示,build是我自己添加了,默认只有其他几个文件及文件夹。

4.reportlab 怎么安装

1. 先安装pip

a)

b) 获取上面网址的get-pip.py

c) 运行python get-pip.py

d) 安装完成之后 pip应用程序安装在C:\Python27\Scripts目录下,把这个路径加到path环境变量里面

e) cmd-》 输入pip -》可看到命令帮助,表示安装成功

2. 下载PIL

a) /products/pil

b) 下载对应版本的文件

c) Exe文件直接安装

3. 下载Reporlab包

a) https://pypi.python.org/pypi/reportlab/

b) 取下对应python版本的whl

c) Pip install 上面取下来的文件

5.Python模块常用的几种安装方式

几种情况

1.预编译好的exe文件,直接双击安装即可

2.rar等包,解压后,从命令行中cd到解压的目录,通过setup.py文件来安装模块:

命令为,python setup.py install (若python未配置环境变量,则需要给python的安装绝对路径,如: C:/python27/python setup.py install)

备注:一般第三方模块安装好后,在 python安装路径/Lib/site-package下可以看得到

6.怎么安装python模块,如何安装python模块,常用安装方式

.

直接copy

下载的模块文件中已经有了模块的文件,有些模块只有一个文件,比如较早版本的BeautifulSoup,有些是一个文件夹,比如新版本BeautifulSoup就是一个叫做bs4的文件夹。

把这些文件直接copy到你的python路径下的/Lib/site-packages文件夹中,比如C:/Python27/Lib/site-packages。之后就可以在程序里直接引用了:

import BeautifulSoup

或者

from bs4 import BeautifulSoup

这是根据你放置的文件位置不同而决定的。

网上有人说直接放在Lib文件夹中就可以了。的确这样也行,但Lib文件夹中都是自带的模块,看一下就会发现我们用过的random、re等模块的代码文件。而外部模块一般放在site-packages文件夹中。

2.

setup.py

很多模块里都附带了setup.py文件,有同学直接双击了,然后发现没有用。

它的使用方法是从命令行去到setup.py所在的路径下,运行

python setup.py install

仔细看一下安装时输出的信息可以发现,在线学习这个命令做的事情其实也就是帮你把模块的代码copy到site-packages文件夹。

3.

setuptools

使用setuptools可以直接根据模块名称来自动下载安装,不需要自己再去寻找模块的安装文件。不过在使用之前,你得先安装setuptools自身。

windows平台的32位python,可以直接下载setuptools的exe文件安装。(去搜索setuptools windows可以找到,我也上传了一份在论坛本帖后面)

Linux用户可以从包管理器中安装,比如ubuntu:

apt-get install python-setuptools

windows平台64位python得用ez_setup.py进行安装(文件我也上传了)。这种方式也适用于所有平台。

在ez_setup.py所在文件夹下运行:

python ez_setup.py

setuptools会被安装在python路径\Scripts下。之后,你可以把这个路径添加到环境变量path中,也可以直接从命令行进入到Scripts文件夹下,执行easy_install,看看是否安装成功了。

之后,你就可以直接用它来安装你想要的模块,比如PIL:

easy_install PIL

视频教程程序就会帮你自动下载安装到site-packages里。

最后,介绍几个不错的模块,供大家参考使用。

PIL - 图形处理

PyXML - 解析和处理XML文件

MySQLdb - 连接MySQL数据库

Tkinter - 图形界面接口,python自带

smtplib - 发送电子邮件

ftplib - ftp编程

PyMedia - 多媒体操作

PyOpenGL - OpenGL接口

BeautifulSoup - HTML/XML的解析器

sphinxpython安装

转载请注明出处编程代码网 » sphinxpython安装(如何使用sphinx生成Python第三方模块的文档)

资讯

python栈与队列(python栈和队列在功能上的区别)

阅读(20)

本文主要为您介绍python栈与队列,内容包括python栈和队列在功能上的区别,python中栈和队列在功能上的区别,python栈和队列在功能上的区别。“栈” 和 “队列” 是数据结构,与具体的语言无关。1.队列先进先出,栈先进后出。2. 对插入和删除操作

资讯

workflowpython(在Python环境下比较好的工作流引擎是什么)

阅读(17)

本文主要为您介绍workflowpython,内容包括在Python环境下比较好的工作流引擎是什么,大家都用python做什么开发,大家都用python做哪些开发。CSDN:FixFlow 和类似的软件如 Activiti jBPM 等相比起来,它们之间有哪些区别呢?FFDT:FixFlow 更加符

资讯

snifferpython(如何让gsmsniffer变得更加智能化)

阅读(19)

本文主要为您介绍snifferpython,内容包括python遇到网络问题时,怎么解决,如何让gsmsniffer变得更加智能化,如何让gsmsniffer变得更加智能化。当python 遇上 Arduino,似乎一切都在变得更加智能化。你还在手动断开你的C118电源吗?你还在手动按

资讯

用python表白(如何用python写一段浪漫的代码)

阅读(20)

本文主要为您介绍用python表白,内容包括如何优雅地向python程序员表白,如何优雅地向python程序员表白,如何用python写一段浪漫的代码。简单的,可以使用python 的CGI模块,需要你的服务器开启CGI支持。网页内容如下:1234567891011<html> <hea

资讯

python上嵌入文字(Python如何在图片上添加带格式的文本)

阅读(19)

本文主要为您介绍python上嵌入文字,内容包括Python如何在图片上添加带格式的文本,怎样用python在图片里添加一段文字,python中关于图片添加文字。打开IDLE软件,导入相关函数库。from PIL import Image, ImageDraw,ImageFontpython如何给

资讯

apache2.4python(如何使用apache发布python项目)

阅读(43)

本文主要为您介绍apache2.4python,内容包括XP+Python2.5+Apache2.2.4+modpython3.3.1的问题我装的是,Python2.4和apache2.2用modwsgi连接如何设置工程目录的路径用什,zope,python,apache之间是什么关系。首先检查以下要求是否已经达到: Apac

资讯

python如何使用源文件(python如何编译使用源文件)

阅读(13)

本文主要为您介绍python如何使用源文件,内容包括简明Python教程里的使用源文件怎么弄啊,python如何编译使用源文件,Python怎么使用源文件。因为系统找不到python.exe,所以说"NO SUCH……“ 你需要进入python目录 c:\python25> 这样的状态输

资讯

python获取股票数据(怎样用python处理股票)

阅读(15)

本文主要为您介绍python获取股票数据,内容包括如何用python获取股票数据,如何用python抓取股票数据,如何用python取所有股票一段时间历史数据。用Python处理股票需要获取股票数据,以国内股票数据为例,可以安装Python的第三方库:tushare;一个国

资讯

python获取客户端ip(python怎么获取本机ip)

阅读(15)

本文主要为您介绍python获取客户端ip,内容包括Python中服务器端获取webservice客户端IP地址,python怎么获取本机ip,求助,python如何获取网站的ip。第一种:复制代码代码如下:import socket import fcntl import struct def get_ip_add

资讯

pythonhttpip伪造(如何伪造http请求的ip地址)

阅读(41)

本文主要为您介绍pythonhttpip伪造,内容包括python可以伪造ip发送http请求吗,如何伪造http请求的ip地址,(pythonsocket伪造client的ip地址)有一python写的socket服务端只接。在项目开发中(web项目),我负责的系统(简称PC),需要调其它系统接口,并且

资讯

python调用windows下的dll(怎样用python调用dll)

阅读(14)

本文主要为您介绍python调用windows下的dll,内容包括Windows下如何在python中调用c语言程序编译的dll,怎样用python调用dll,如何用python调用应用程序的.dll文件。可以的,python中一般有两种方法调用DLL中的函数。1.直接使用函数名,函数名可

资讯

pythonrpyc安装(pythonsimpleitk怎么安装)

阅读(17)

本文主要为您介绍pythonrpyc安装,内容包括pythonsimpleitk怎么安装,python怎么装"matplotlib",tesserocrpython怎么安装。python中安装第三方库用pip install SImpleITK语句即可但是SImpleITK库你有可能安装不上(我也不知道为什么

资讯

shellpython比较(Linux下编写脚本Shell和Python的区别)

阅读(19)

本文主要为您介绍shellpython比较,内容包括python和shell的区别,python和shell的区别,python和shell有什么区别。思路和算法可以一样,但是语法不一样啊。例如求1+2+3+4+,和超过10000止 shell,c,python实现思路类似。 shell

资讯

rpm安装python(怎样将python程序及其依赖打包成rpm包部署)

阅读(15)

本文主要为您介绍rpm安装python,内容包括怎样将python程序及其依赖打包成rpm包部署,怎样将python程序及其依赖打包成rpm包部署,我在linux下安装python2.6.22.fc12.i686.rpm软件包时出错python和。可以的,虽然说pip比较流行,但rpm从原理上完全

资讯

pythonflask文件(如何在python3中安装flask)

阅读(16)

本文主要为您介绍pythonflask文件,内容包括如何在python3中安装flask,怎么安装flask和python,Python3.4怎么安装Flask。看看本机pip安装了没有。 (推荐安装最新的3.5,自带pip)如果安装了则在命令行内输入1pip install flask如果没有。

资讯

python51job(pythonsimpleitk怎么安装)

阅读(16)

本文主要为您介绍python51job,内容包括python能做什么工作,学会python可以做哪些兼职,python能做什么工作。python中安装第三方库用pip install SImpleITK语句即可但是SImpleITK库你有可能安装不上(我也不知道为什么

资讯

python在c盘安装路径(怎样查看python安装路径)

阅读(17)

本文主要为您介绍python在c盘安装路径,内容包括怎么在win10找python安装路径,安装python怎么设置安装路径,怎样查看python安装路径。方法如下:linux查看python安装位置。有时我们需要查看python的安装位置,好安装第三方库,linux可以先python进

资讯

python32位64位(windows7下怎么安装Python3.5.1)

阅读(17)

本文主要为您介绍python32位64位,内容包括如何下载python,python32位安装在64位电脑可以不,怎么查看python是32位还是64位的。到python的官方网站下载最新的python安装程序,目前最新版本是3.5.1。要注意 在下载页面,有两个类型的PYTHON ,pyt

资讯

pythonrequests出错(pythonpip安装requests时报错,怎么解决)

阅读(17)

本文主要为您介绍pythonrequests出错,内容包括pythonpip安装requests时报错,怎么解决,关于安装pythonrequests时出现了以下问题,怎么解决啊,希望大神解,使用python的requests库运行http请求,请问如图的报错是什么原因,。分析原因:总以为没有

资讯

python和pycharm安装(如何使用pycharm安装python库)

阅读(17)

本文主要为您介绍python和pycharm安装,内容包括如何在python中安装pycharm,如何使用pycharm安装python库,python怎么和pycharm进行配置。首先我们来安装python:首先进入网站下载:点击打开链接(或自己输入网址https://www.python.org/download