doc2dash CLI全選項(xiàng)詳解--full-text-search到--playground-url的終極參數(shù)手冊(cè)【免費(fèi)下載鏈接】doc2dashCreate docsets for Dash.app-compatible API browsers.項(xiàng)目地址: https://gitcode.com/gh_mirrors/do/doc2dashdoc2dash 是一款開源的命令行工具能把 Sphinx、pydoctor 等生成的 HTML 文檔一鍵轉(zhuǎn)換成 Dash.app 兼容的docset離線 API 瀏覽器數(shù)據(jù)源。只需一條命令就能把任意在線文檔裝進(jìn) Dash實(shí)現(xiàn)高速離線檢索。本文逐一拆解 doc2dash CLI 的全部參數(shù)——從最基礎(chǔ)的SOURCE到--full-text-search、--playground-url給你一份可直接查閱的終極參數(shù)手冊(cè)。 參數(shù)速查表一張表看懂全部選項(xiàng)選項(xiàng)短選項(xiàng)作用SOURCE—必填待轉(zhuǎn)換的 HTML 文檔目錄--name-n手動(dòng)指定 docset 名稱--destination-ddocset 輸出目錄默認(rèn)當(dāng)前目錄--force-f目標(biāo)已存在時(shí)強(qiáng)制覆蓋--icon-i為 docset 添加 PNG 圖標(biāo)--icon-2x—添加高分屏用的 2x 圖標(biāo)--index-page-I點(diǎn)擊 docset 時(shí)默認(rèn)打開的頁面--add-to-dash-a生成后自動(dòng)加入 Dash僅 macOS--add-to-global-A輸出到全局默認(rèn)目錄并自動(dòng)加入 Dash--quiet-q只輸出錯(cuò)誤和警告--verbose-v輸出更詳細(xì)的調(diào)試信息--enable-js-j啟用文檔中內(nèi)嵌與外部 JavaScript--online-redirect-url-u本地查不到時(shí)跳轉(zhuǎn)的在線文檔地址--playground-url—設(shè)置 docset 的 playground 地址--parser—手動(dòng)指定解析器類的導(dǎo)入路徑--full-text-search—全文搜索on/off/forbidden--version—顯示 doc2dash 版本號(hào)全部參數(shù)定義在src/doc2dash/__main__.py中官方用法文檔見docs/cli.md。 快速上手一條命令安裝 docset安裝 doc2dash 后最常用的命令只有一個(gè)doc2dash -A DOCS_DIR它會(huì)在~/Library/Application Support/doc2dash/DocSets下創(chuàng)建DOCS_DIR.docset并自動(dòng)把它加入 Dash。下圖是一個(gè)真實(shí)的 doc2dash CLI 終端會(huì)話三個(gè)基礎(chǔ)選項(xiàng)值得先記住SOURCE唯一必填參數(shù)指向生成好的 HTML 文檔目錄且必須是可讀的目錄路徑--name / -n不傳時(shí)解析器會(huì)嘗試從文檔中猜測名稱猜不到就用目錄名--destination / -d指定輸出位置默認(rèn)當(dāng)前目錄。注意使用了-A時(shí)該選項(xiàng)會(huì)被忽略--force / -f目標(biāo) docset 目錄已存在時(shí)默認(rèn)會(huì)報(bào)錯(cuò)退出加-f則先刪除再生成。 --full-text-search全文搜索的三態(tài)開關(guān)Dash 的全文搜索FTS會(huì)對(duì) docset 中所有正文內(nèi)容建立索引。--full-text-search有三個(gè)取值對(duì)應(yīng)src/doc2dash/docsets.py中的FullTextSearch枚舉取值效果off默認(rèn)默認(rèn)關(guān)閉用戶可在 Dash 中自行開啟on向Info.plist寫入DashDocSetDefaultFTSEnabled打開即默認(rèn)啟用forbidden寫入DashDocSetFTSNotSupported用戶完全無法開啟怎么選文檔體量小直接on搜索體驗(yàn)最爽文檔巨大幾萬個(gè)頁面時(shí)FTS 索引會(huì)顯著拖慢 Dash 整體搜索速度果斷用forbidden。 --online-redirect-url 與 --playground-url打通線上世界離線 docset 也有覆蓋不到的內(nèi)容這兩個(gè)參數(shù)讓 Dash 能無縫銜接線上資源--online-redirect-url / -u填寫在線文檔的基礎(chǔ) URL寫入DashDocSetFallbackURL。在 Dash 中查不到詞條時(shí)會(huì)自動(dòng)跳到在線文檔對(duì)應(yīng)頁面--playground-url寫入DashDocSetPlayURL為 docset 配置 playground 地址點(diǎn)擊 API 詞條時(shí)可直達(dá)對(duì)應(yīng)的在線沙盒/調(diào)試頁面。? 界面美化--icon、--icon-2x 與 --index-page--icon / -i給 docset 添加圖標(biāo)。程序會(huì)校驗(yàn) PNG 文件頭非 PNG 圖片直接報(bào)錯(cuò)退出--icon-2xRetina 高分屏專用的 2 倍尺寸圖標(biāo)建議與-i搭配使用--index-page / -I指定點(diǎn)擊 docset 時(shí)默認(rèn)展示的頁面相對(duì)SOURCE根目錄的文件名如index.html文件不存在時(shí)會(huì)報(bào)錯(cuò)。? 執(zhí)行細(xì)節(jié)--quiet、--verbose 與 --enable-js--quiet / -q壓制進(jìn)度輸出只保留錯(cuò)誤和警告適合放進(jìn) CI 腳本--verbose / -v輸出詳細(xì)日志排查為什么沒識(shí)別出文檔類型這類問題?? 兩者不能同時(shí)使用程序會(huì)直接報(bào)makes no sense退出--enable-js / -j啟用文檔中的 JavaScript。很多現(xiàn)代文檔站如交互式 API 參考離開 JS 就殘廢按需開啟另外doc2dash 支持NO_COLOR環(huán)境變量可統(tǒng)一關(guān)閉終端彩色輸出。? --parser手動(dòng)指定文檔解析器默認(rèn)情況下 doc2dash 會(huì)自動(dòng)檢測文檔類型如 Sphinx、pydoctor。當(dāng)自動(dòng)檢測失敗、或文檔格式長得像別的類型時(shí)用--parser傳入解析器類的導(dǎo)入路徑即可強(qiáng)制指定例如doc2dash -A --parser doc2dash.parsers.intersphinx.InterSphinxParser DOCS_DIR內(nèi)置 Intersphinx 解析器的實(shí)現(xiàn)位于src/doc2dash/parsers/intersphinx.py轉(zhuǎn)換與索引的核心邏輯在src/doc2dash/convert.py想擴(kuò)展自己的解析器也可以從這里入手?jǐn)U展方式參見docs/extending.md。 高頻組合示例場景命令一鍵全局安裝doc2dash -A DOCS_DIR強(qiáng)制覆蓋 默認(rèn)開啟全文搜索doc2dash -A -f --full-text-searchon DOCS_DIR啟用 JS 線上兜底跳轉(zhuǎn)doc2dash -A -j -u https://your-docs.example.com DOCS_DIR指定名稱和輸出目錄doc2dash -n MyLib -d ./out -I index.html DOCS_DIR完全禁止全文搜索大文檔doc2dash -A --full-text-searchforbidden DOCS_DIR掌握以上 17 個(gè)選項(xiàng)doc2dash 的基本功就算打齊了-A負(fù)責(zé)一鍵安裝--full-text-search決定搜索體驗(yàn)--online-redirect-url/--playground-url銜接線上世界--parser兜底特殊格式。把這份手冊(cè)放在手邊按需取用即可?！久赓M(fèi)下載鏈接】doc2dashCreate docsets for Dash.app-compatible API browsers.項(xiàng)目地址: https://gitcode.com/gh_mirrors/do/doc2dash創(chuàng)作聲明：本文部分內(nèi)容由AI輔助生成（AIGC），僅供參考