18910140161

sphinx使用及其简单配置

顺晟科技

2021-06-16 10:58:34

183

一、sphinx使用

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

cd /home/wwwroot/doc

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

sphinx-quickstart

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

输入文档的根路径。文档的根路径[。]://输入跟目录,直接回车您有两个选项来放置狮身人面像输出的构建目录。要么在根路径中使用目录" _build ",要么在根路径中分隔“来源”和“构建”目录。分离源目录和构建目录(y/N) [n]://是否分离来源和建设目录,建议选y,方便管理在根目录中,将创建两个以上的目录;'自定义超文本标记语言模板的"模板",自定义样式表和其他静态文件的"静态"。您可以输入另一个前缀(如"."))替换下划线。模板和静态目录的名称前缀[_]://直接回车项目名称将出现在构建文档的几个地方。项目名称: F2E烹饪书作者名称: imbindian//输入项目名称//输入作者名称源文件的文件名后缀。通常情况下,这是两者之一. txt'or ' .rst .只有带有此后缀的文件才被视为文档。源文件后缀[。rst]:txt//档文件的扩展名,默认是rst//后面的操作基本回车就好

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

构建-生成文档目录来源-源文件目录make.bat makefile

生成超文本标记语言文档

制作超文本标记语言

看一下建设目录下是不是生成了超文本标记语言文档了?

^_^享受它!

二、sphinx简单配置

来源目录下的conf.py文件为狮身人面像的配置文件。

1)修改文档语言为中文:

找到#语言=无,修改为:语言='zh_CN ',其它语言见下表

bn孟加拉语加泰罗尼亚语捷克语丹麦语德语英语西班牙语芬兰语法语克罗地亚语意大利语日语立陶宛语荷兰语波兰语_ BR巴西葡萄牙语俄罗斯语斯洛文尼亚语土耳其语_乌克兰语_ CN简体中文zh _ TW繁体中文

设置主题

找到html_theme='默认,修改系统默认值即可。目前官方提供的主题见sphinx.pocoo.org/theming.html#builtin-themes

其它

还其它更多设置,具体请参考官方文档。

设置好以后,重新制作超文本标记语言即可。

扩展阅读:

http://sphinx.pocoo.org/contents.html' target=" _ blank " http://狮身人面像。波库。组织/目录。超文本标记语言

我们已经准备好了,你呢?
2024我们与您携手共赢,为您的企业形象保驾护航