国产探花免费观看_亚洲丰满少妇自慰呻吟_97日韩有码在线_资源在线日韩欧美_一区二区精品毛片,辰东完美世界有声小说,欢乐颂第一季,yy玄幻小说排行榜完本

首頁(yè) > 網(wǎng)站 > 建站經(jīng)驗(yàn) > 正文

sphinx使用及其簡(jiǎn)單配置方法

2019-11-02 16:10:45
字體:
來(lái)源:轉(zhuǎn)載
供稿:網(wǎng)友
sphinx使用

進(jìn)入你要?jiǎng)?chuàng)建文檔的目錄,例如要?jiǎng)?chuàng)建在目錄/home/wwwroot/doc下

cd /home/wwwroot/doc

開始使用向?qū)?chuàng)建你的文檔項(xiàng)目

sphinx-quickstart

程序會(huì)提示輸入一些選項(xiàng),如輸入根目錄,大部分使用默認(rèn)選項(xiàng),直接按回車即可。

復(fù)制代碼 代碼如下:

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

//輸入項(xiàng)目名稱

//輸入作者名稱

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

//檔文件的擴(kuò)展名,默認(rèn)是.rst

//后面的操作基本回車就好

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

build--生成文檔目錄

source--源文件目錄

make.bat

makefile

生成html文檔

make html

看一下build目錄下是不是生成了html文檔了?

^_^ enjoy it!

查看demo:http://doc.litejs.com/

sphinx簡(jiǎn)單配置

source目錄下的conf.py文件為sphinx的配置文件。

1)修改文檔語(yǔ)言為中文:

找到#language = None,修改為:language ='zh_CN',其它語(yǔ)言見下表

復(fù)制代碼 代碼如下:

bn 主站蜘蛛池模板: 澄城县| 恭城| 双牌县| 五河县| 准格尔旗| 宜阳县| 且末县| 育儿| 吴江市| 金华市| 白朗县| 正安县| 惠安县| 高清| 仁寿县| 苏尼特右旗| 新和县| 汤阴县| 曲周县| 衡阳市| 宝鸡市| 五大连池市| 栾川县| 新乡市| 霍邱县| 怀宁县| 绥中县| 左云县| 大城县| 西盟| 盐源县| 渭南市| 屏东市| 汶川县| 仙游县| 绥芬河市| 安义县| 高平市| 雷州市| 柘城县| 稻城县|