sphinx使用及其简单配置（sphinx 使用）

sphinx使用及其简单配置（sphinx 使用）

一、sphinx使用

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

cd /home/wwwroot/doc

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

sphinx-quickstart

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

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

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

生成html文档

make html

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

^_^ enjoy it!

二、sphinx简单配置

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

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

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

bn – Bengalica – Catalancs – Czechda – Danishde – Germanen – Englishes – Spanishfi – Finnishfr – Frenchhr – Croatianit – Italianja – Japaneselt – Lithuaniannl – Dutchpl – Polishpt_BR – Brazilian Portugueseru – Russiansl – Sloveniantr – Turkishuk_UA – Ukrainianzh_CN – Simplified Chinesezh_TW – Traditional Chinese

设置主题

找到html_theme = 'default'，修改default即可。目前官方提供的主题见sphinx.pocoo.org/theming.html#builtin-themes

其它

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

设置好以后，重新make html即可。

扩展阅读：

http://sphinx.pocoo.org/contents.html

版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们jiasou666@gmail.com 处理，核实后本网站将在24小时内删除侵权内容。