sphinx使用及其简单配置

2019-09-09 郑州网站建设  

进入你要创建文档的目录,例如要创建在目录/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 staticfiles. 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!

二、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即可。目前官方提供的主题见


河南郑州做网站首选天择文化,我们专注郑州网站建设网站设计网站制作与开发,是中原地区专业的郑州网络公司,多年来我们一直努力,服务客户数百家,欢迎您的咨询。
本文链接:郑州网络公司http://tzchb.ieyo.com/dede/1574.html转载请标明出处,谢谢合作!
标签:
  • 使用
  • 文档
  • 创建
  • ü
  • 进入
  • sphinx