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