使用Sphinx生成项目的Read the Docs

环境配置

# pip install sphinx sphinx_rtd_theme

# tree
文件夹 PATH 列表
卷序列号为 0007-1DAC
D:.
├─web
      └─web_gzip.py

创建api文档

# 在代码目录中创建doc目录，存放相应的信息
# sphinx-apidoc -o ./doc/ . 
Creating file ./doc/web_gzip.rst.
Creating file ./doc/modules.rst.

运行sphinx-quictstart

# sphinx-quickstart

![Paste_Image.png](http://upload-images.jianshu.io/upload_images/6800605-6f1b44ecc2a2000d.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240)

![Paste_Image.png](http://upload-images.jianshu.io/upload_images/6800605-08d3b9b96c02c521.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240)


5. 修改conf.py
在最开始处加入rtd theme相关配置

![Paste_Image.png](http://upload-images.jianshu.io/upload_images/6800605-3736a4fdf31fec7e.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240)

同时要注释原来的theme设置

![Paste_Image.png](http://upload-images.jianshu.io/upload_images/6800605-15b23c25776f56d5.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240)



6. 修改index.rst

![Paste_Image.png](http://upload-images.jianshu.io/upload_images/6800605-3b88ded88b38e46f.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240)

7. 执行make.bat html

![Paste_Image.png](http://upload-images.jianshu.io/upload_images/6800605-0ca6237c8e8a0cf6.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240)

8. 查看

![Paste_Image.png](http://upload-images.jianshu.io/upload_images/6800605-8dd5ac2acc42f835.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240)

![Paste_Image.png](http://upload-images.jianshu.io/upload_images/6800605-8d9d7cd4df1a4026.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240)

![Paste_Image.png](http://upload-images.jianshu.io/upload_images/6800605-67e937b6f8f0374b.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240)

最后编辑于：2017.12.08 13:55:08

人面猴
序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
沈念sama阅读 213,254评论 6赞 492
死咒
序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
沈念sama阅读 90,875评论 3赞 387
救了他两次的神仙让他今天三更去死
文/潘晓璐我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
开封第一讲书人阅读 158,682评论 0赞 348
道士缉凶录：失踪的卖姜人
文/不坏的土叔我叫张陵，是天一观的道长。经常有香客问我，道长，这世上最难降的妖魔是什么？我笑而不...
开封第一讲书人阅读 56,896评论 1赞 285
港岛之恋（遗憾婚礼）
正文为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
茶点故事阅读 66,015评论 6赞 385
恶毒庶女顶嫁案：这布局不是一般人想出来的
文/花漫我一把揭开白布。她就那样静静地躺着，像睡着了一般。火红的嫁衣衬着肌肤如雪。梳的纹丝不乱的头发上，一...
开封第一讲书人阅读 50,152评论 1赞 291
城市分裂传说
那天，我揣着相机与录音，去河边找鬼。笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。我是一名探鬼主播，决...
沈念sama阅读 39,208评论 3赞 412
双鸳鸯连环套：你想象不到人心有多黑
文/苍兰香墨我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
开封第一讲书人阅读 37,962评论 0赞 268
万荣杀人案实录
序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
沈念sama阅读 44,388评论 1赞 304
护林员之死
正文独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋以下内容为张勋视角年9月15日...
茶点故事阅读 36,700评论 2赞 327
白月光启示录
正文我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
茶点故事阅读 38,867评论 1赞 341
活死人
序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
沈念sama阅读 34,551评论 4赞 335
日本核电站爆炸内幕
正文年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
茶点故事阅读 40,186评论 3赞 317
男人毒药：我在死后第九天来索命
文/蒙蒙一、第九天我趴在偏房一处隐蔽的房顶上张望。院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
开封第一讲书人阅读 30,901评论 0赞 21
一桩弑父案，背后竟有这般阴谋
文/苍兰香墨我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。一阵脚步声响...
开封第一讲书人阅读 32,142评论 1赞 267
情欲美人皮
我被黑心中介骗来泰国打工，没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。一个月前我还...
沈念sama阅读 46,689评论 2赞 362
代替公主和亲
正文我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
茶点故事阅读 43,757评论 2赞 351

使用Sphinx生成项目的Read the Docs

推荐阅读更多精彩内容