sphinx使用及其简单配置-mysql教程-PHP中文网

sphinx使用及其简单配置

php中文网

发布： 2016-06-07 16:30:20

原创

1261人浏览过

一、sphinx使用进入你要创建文档的目录，例如要创建在目录/home/wwwroot/doc下 cd /home/wwwroot/doc 开始使用向导创建你的文档项目 sphinx-quickstart 程序会提示输入一些选项，如输入根目录,大部分使用默认选项，直接按回车即可。 Enter the root path fo

一、sphinx使用

进入你要创建文档的目录，例如要创建在目录/home/wwwroot/doc下

cd /home/wwwroot/doc

登录后复制

开始使用向导创建你的文档项目

sphinx-quickstart

登录后复制

程序会提示输入一些选项，如输入根目录,大部分使用默认选项，直接按回车即可。

Enter the root path for documentation.
> Root path for the documentation [.]:
//输入跟目录，直接回车
You have two options for placing the build directory for Sphinx output.
Either, you use a directory "_build" within the root path, or you separate
"source" and "build" directories within the root path.
> Separate source and build directories (y/N) [n]:
//是否分离source和build目录，建议选y,方便管理
Inside the root directory, two more directories will be created; "_templates"
for custom HTML templates and "_static" for custom stylesheets and other static
files. You can enter another prefix (such as ".") to replace the underscore.
> Name prefix for templates and static dir [_]:
//直接回车
The project name will occur in several places in the built documentation.
> Project name: F2E Cookbook
> Author name(s): imbingdian
//输入项目名称
//输入作者名称
The file name suffix for source files. Commonly, this is either ".txt"
or ".rst".  Only files with this suffix are considered documents.
> Source file suffix [.rst]: .txt
//档文件的扩展名，默认是.rst
//后面的操作基本回车就好

登录后复制

完成后可以看到doc文件中生了以下目录文件

build--生成文档目录
source--源文件目录
make.bat 
makefile

登录后复制

生成html文档

make html

登录后复制

看一下build目录下是不是生成了html文档了?

^_^ enjoy it!

乐彼多用户商城系统LBMall(.net)

乐彼多用户商城系统，采用ASP.NET分层技术和AJAX技术，运营于高速稳定的微软.NET+MSSQL 2005平台；完全具备搭建超大型网络购物多用户网上商城的整体技术框架和应用层次LBMall 秉承乐彼软件优秀品质，后台人性化设计，管理窗口识别客户端分辨率自动调整，独立配置的菜单操作锁，使管理操作简单便捷。待办事项1、新订单、支付、付款、短信提醒2、每5分钟自动读取3、新事项声音提醒店铺管理1

查看详情

二、sphinx简单配置

source目录下的conf.py文件为sphinx的配置文件。

1）修改文档语言为中文：

找到#language = None，修改为：language ='zh_CN'，其它语言见下表

bn – Bengali
ca – Catalan
cs – Czech
da – Danish
de – German
en – English
es – Spanish
fi – Finnish
fr – French
hr – Croatian
it – Italian
ja – Japanese
lt – Lithuanian
nl – Dutch
pl – Polish
pt_BR – Brazilian Portuguese
ru – Russian
sl – Slovenian
tr – Turkish
uk_UA – Ukrainian
zh_CN – Simplified Chinese
zh_TW – Traditional Chinese

登录后复制