使用Sphinx生成項目的Read the Docs

  1. 環(huán)境配置
# pip install sphinx sphinx_rtd_theme
  1. 原始代碼目錄
# tree
文件夾 PATH 列表
卷序列號為 0007-1DAC
D:.
├─web
      └─web_gzip.py
  1. 創(chuàng)建api文檔
# 在代碼目錄中創(chuàng)建doc目錄瘪菌，存放相應(yīng)的信息
# sphinx-apidoc -o ./doc/ . 
Creating file ./doc/web_gzip.rst.
Creating file ./doc/modules.rst.
  1. 運(yùn)行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相關(guān)配置

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

同時要注釋原來的theme設(shè)置

![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. 執(zhí)行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)
最后編輯于 ：
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 人面猴
    序言：七十年代末糯崎，一起剝皮案震驚了整個濱河市，隨后出現(xiàn)的幾起案子梗顺，更是在濱河造成了極大的恐慌，老刑警劉巖，帶你破解...
    沈念sama閱讀 222,104評論 6贊 515
  • 死咒
    序言：濱河連續(xù)發(fā)生了三起死亡事件妖谴，死亡現(xiàn)場離奇詭異囚戚，居然都是意外死亡酵熙，警方通過查閱死者的電腦和手機(jī)，發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 94,816評論 3贊 399
  • 救了他兩次的神仙讓他今天三更去死
    文/潘曉璐 我一進(jìn)店門驰坊，熙熙樓的掌柜王于貴愁眉苦臉地迎上來匾二，“玉大人，你說我怎么就攤上這事拳芙〔烀辏” “怎么了？”我有些...
    開封第一講書人閱讀 168,697評論 0贊 360
  • 道士緝兇錄：失蹤的賣姜人
    文/不壞的土叔 我叫張陵态鳖，是天一觀的道長转培。 經(jīng)常有香客問我，道長浆竭，這世上最難降的妖魔是什么浸须？ 我笑而不...
    開封第一講書人閱讀 59,836評論 1贊 298
  • ?港島之戀（遺憾婚禮）
    正文 為了忘掉前任惨寿，我火速辦了婚禮，結(jié)果婚禮上删窒，老公的妹妹穿的比我還像新娘裂垦。我一直安慰自己，他們只是感情好肌索，可當(dāng)我...
    茶點故事閱讀 68,851評論 6贊 397
  • 惡毒庶女頂嫁案：這布局不是一般人想出來的
    文/花漫 我一把揭開白布蕉拢。 她就那樣靜靜地躺著，像睡著了一般诚亚。 火紅的嫁衣襯著肌膚如雪晕换。 梳的紋絲不亂的頭發(fā)上，一...
    開封第一講書人閱讀 52,441評論 1贊 310
  • 城市分裂傳說
    那天站宗，我揣著相機(jī)與錄音闸准，去河邊找鬼。 笑死梢灭，一個胖子當(dāng)著我的面吹牛夷家，可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播敏释，決...
    沈念sama閱讀 40,992評論 3贊 421
  • 雙鴛鴦連環(huán)套：你想象不到人心有多黑
    文/蒼蘭香墨 我猛地睜開眼库快，長吁一口氣：“原來是場噩夢啊……” “哼！你這毒婦竟也來了钥顽？” 一聲冷哼從身側(cè)響起义屏，我...
    開封第一講書人閱讀 39,899評論 0贊 276
  • 萬榮殺人案實錄
    序言：老撾萬榮一對情侶失蹤，失蹤者是張志新（化名）和其女友劉穎耳鸯，沒想到半個月后湿蛔，有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體，經(jīng)...
    沈念sama閱讀 46,457評論 1贊 318
  • ?護(hù)林員之死
    正文 獨居荒郊野嶺守林人離奇死亡县爬，尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 38,529評論 3贊 341
  • ?白月光啟示錄
    正文 我和宋清朗相戀三年灵奖，在試婚紗的時候發(fā)現(xiàn)自己被綠了画恰。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片荣回。...
    茶點故事閱讀 40,664評論 1贊 352
  • 活死人
    序言：一個原本活蹦亂跳的男人離奇死亡立砸，死狀恐怖，靈堂內(nèi)的尸體忽然破棺而出耳高，到底是詐尸還是另有隱情扎瓶，我是刑警寧澤，帶...
    沈念sama閱讀 36,346評論 5贊 350
  • ?日本核電站爆炸內(nèi)幕
    正文 年R本政府宣布泌枪，位于F島的核電站概荷，受9級特大地震影響，放射性物質(zhì)發(fā)生泄漏碌燕。R本人自食惡果不足惜误证，卻給世界環(huán)境...
    茶點故事閱讀 42,025評論 3贊 334
  • 男人毒藥：我在死后第九天來索命
    文/蒙蒙 一继薛、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧愈捅，春花似錦遏考、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,511評論 0贊 24
  • 一樁弒父案灌具，背后竟有這般陰謀
    文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至譬巫，卻和暖如春咖楣，著一層夾襖步出監(jiān)牢的瞬間，已是汗流浹背缕题。 一陣腳步聲響...
    開封第一講書人閱讀 33,611評論 1贊 272
  • 情欲美人皮
    我被黑心中介騙來泰國打工截歉， 沒想到剛下飛機(jī)就差點兒被人妖公主榨干…… 1. 我叫王不留胖腾，地道東北人烟零。 一個月前我還...
    沈念sama閱讀 49,081評論 3贊 377
  • 代替公主和親
    正文 我出身青樓，卻偏偏與公主長得像咸作，于是被迫代替她去往敵國和親锨阿。 傳聞我的和親對象是個殘疾皇子，可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 45,675評論 2贊 359

推薦閱讀更多精彩內(nèi)容