摘要:項(xiàng)目用文檔生成使用內(nèi)置命令得到文件自己編輯或者加上然后直接注意需要在里面加入項(xiàng)目路徑讓他能夠如果路徑很深需要后面參數(shù)根據(jù)情況
python項(xiàng)目用sphinx文檔生成 使用內(nèi)置命令
sphinx-apidoc -o doc waterfal
得到 rst 文件
localhost:doc timger$ ls modules.rst waterfall.glblog.rst waterfall.master.rst waterfall.rst waterfall.excepts.rst waterfall.lib.rst waterfall.p2plog.rst waterfall.slowspeed.rst
自己編輯 conf.py
或者加上 -F
localhost:waterfall timger$ sphinx-apidoc -F -o doc waterfall Creating file doc/waterfall.rst. Creating file doc/waterfall.excepts.rst. Creating file doc/waterfall.glblog.rst. Creating file doc/waterfall.lib.rst. Creating file doc/waterfall.master.rst. Creating file doc/waterfall.p2plog.rst. Creating file doc/waterfall.slowspeed.rst. Creating file doc/conf.py. Creating file doc/index.rst. Creating file doc/Makefile. Creating file doc/make.bat.
然后 直接 make html
注意需要在 conf.py 里面加入項(xiàng)目路徑讓他能夠 import
如果路徑很深 需要 -d 10 后面參數(shù)根據(jù)情況
文章版權(quán)歸作者所有,未經(jīng)允許請(qǐng)勿轉(zhuǎn)載,若此文章存在違規(guī)行為,您可以聯(lián)系管理員刪除。
轉(zhuǎn)載請(qǐng)注明本文地址:http://m.specialneedsforspecialkids.com/yun/37313.html
摘要:項(xiàng)目代碼認(rèn)識(shí)是一個(gè)基于的文檔生成項(xiàng)目。文檔項(xiàng)目起始文件。將之前的文檔用管理,并推送到,然后在中即可。完成后使用更新。設(shè)置文檔你的第一本書作者最后,編譯會(huì)完成轉(zhuǎn)換為并將生成,可以手動(dòng)分開在下可以查看到生成的文檔。 這幾天準(zhǔn)備編排部分翻譯的書籍和文檔,找了好些工具,最終定格在 Sphinx 上,并基于 ReadTheDocs 提供的 SaaS 服務(wù)進(jìn)行分發(fā)和分享。本篇博客是對(duì)整個(gè)過(guò)程的一次...
摘要:簡(jiǎn)介是一個(gè)用于快速生成文檔的工具,非常適合生成文檔。稱之為主文檔,它被作為歡迎頁(yè)面。由于是默認(rèn)的域,所以并不需要特別指出所屬的域來(lái)。自動(dòng)生成文檔注釋支持從源代碼中提取文檔注釋信息,然后生成文檔,我們將這稱之為。 簡(jiǎn)介 sphinx是一個(gè)用于快速生成文檔的工具,非常適合生成Python文檔。 它具有以下優(yōu)點(diǎn): 支持多種輸出格式, 如html,Latex,ePub等。 豐富的擴(kuò)展 結(jié)構(gòu)化...
摘要:此文成于年月現(xiàn)狀目前的穩(wěn)定版本為目前對(duì)英文等字母語(yǔ)言采用空格分詞故其對(duì)中文分詞支持不好目前官方中文分詞方案僅支持按單字分詞在基礎(chǔ)上目前國(guó)內(nèi)有兩個(gè)中文分詞解決方案一個(gè)是一個(gè)是沒(méi)有官網(wǎng)文檔較少可查到的最新版本可支持官方還在維護(hù)但貌似不打 NOTE : 此文成于 2017 年 3 月. 現(xiàn)狀: Sphinx 目前的穩(wěn)定版本為 2.2.11.Sphinx 目前對(duì)英文等字母語(yǔ)言采用空格分詞,故...
摘要:此文成于年月現(xiàn)狀目前的穩(wěn)定版本為目前對(duì)英文等字母語(yǔ)言采用空格分詞故其對(duì)中文分詞支持不好目前官方中文分詞方案僅支持按單字分詞在基礎(chǔ)上目前國(guó)內(nèi)有兩個(gè)中文分詞解決方案一個(gè)是一個(gè)是沒(méi)有官網(wǎng)文檔較少可查到的最新版本可支持官方還在維護(hù)但貌似不打 NOTE : 此文成于 2017 年 3 月. 現(xiàn)狀: Sphinx 目前的穩(wěn)定版本為 2.2.11.Sphinx 目前對(duì)英文等字母語(yǔ)言采用空格分詞,故...
閱讀 3301·2023-04-26 02:09
閱讀 2603·2021-11-24 09:39
閱讀 3292·2021-11-16 11:52
閱讀 3627·2021-10-26 09:50
閱讀 2783·2021-10-08 10:05
閱讀 2468·2021-09-22 15:25
閱讀 3313·2019-08-30 13:14
閱讀 926·2019-08-29 17:06