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），仅供参考