|
马上注册,结交更多好友,享用更多功能,让你轻松玩转社区。
您需要 登录 才可以下载或查看,没有帐号?立即注册
x
如果你只是想应付一下操作系统的课程,劝你最好别学,或者说不要指望能用的怎么样。
sphinx利用
进进你要创立文档的目次,比方要创立在目次/home/wwwroot/doc下
cd/home/wwwroot/doc
入手下手利用导游创立你的文档项目
sphinx-quickstart
程序会提醒输出一些选项,如输出根目次,年夜部分利用默许选项,间接按回车便可。
.代码以下:
Entertherootpathfordocumentation.
>Rootpathforthedocumentation[.]:
//输出跟目次,间接回车
YouhavetwooptionsforplacingthebuilddirectoryforSphinxoutput.
Either,youuseadirectory"_build"withintherootpath,oryouseparate
"source"and"build"directorieswithintherootpath.
>Separatesourceandbuilddirectories(y/N)[n]:
//是不是分别source和build目次,倡议选y,便利办理
Insidetherootdirectory,twomoredirectorieswillbecreated;"_templates"
forcustomHTMLtemplatesand"_static"forcustomstylesheetsandotherstatic
files.Youcanenteranotherprefix(suchas".")toreplacetheunderscore.
>Nameprefixfortemplatesandstaticdir[_]:
//间接回车
Theprojectnamewilloccurinseveralplacesinthebuiltdocumentation.
>Projectname:F2ECookbook
>Authorname(s):imbingdian
//输出项目称号
//输出作者称号
Thefilenamesuffixforsourcefiles.Commonly,thisiseither".txt"
or".rst".Onlyfileswiththissuffixareconsidereddocuments.
>Sourcefilesuffix[.rst]:.txt
//档文件的扩大名,默许是.rst
//前面的操纵基础回车就好
完成后能够看到doc文件中生了以下目次文件
build--天生文档目次
source--源文件目次
make.bat
makefile
天生html文档
makehtml
看一下build目次下是否是天生了html文档了?
^_^enjoyit!
检察demo:http://doc.litejs.com/
sphinx复杂设置
source目次下的conf.py文件为sphinx的设置文件。
1)修正文档言语为中文:
找到#language=None,修正为:language=zh_CN,别的言语见下表
.代码以下:
bnCBengali
caCCatalan
csCCzech
daCDanish
deCGerman
enCEnglish
esCSpanish
fiCFinnish
frCFrench
hrCCroatian
itCItalian
jaCJapanese
ltCLithuanian
nlCDutch
plCPolish
pt_BRCBrazilianPortuguese
ruCRussian
slCSlovenian
trCTurkish
uk_UACUkrainian
zh_CNCSimplifiedChinese
zh_TWCTraditionalChinese
2)设置主题
找到html_theme=default,修正default便可。今朝官方供应的主题见http://sphinx.pocoo.org/theming.html#builtin-themes
3)别的
还别的更多设置,详细请参考官方文档。
设置好今后,从头makehtml便可。
扩大浏览:
- http://sphinx.pocoo.org/contents.html
http://blog.s135.com/read.php?360
常用的linux命令,尤其是一些能帮你提高开发效率的命令,(eg:grep,awk,sed,split等); |
|