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),仅供参考

相关新闻

低成本LoRA微调ChatGLM3-6B:从数据准备到模型部署

低成本LoRA微调ChatGLM3-6B:从数据准备到模型部署

简介:大模型微调是推动AI应用落地的关键环节,但全参微调动辄需要多张高端显卡,门槛极高。参数高效微调技术LoRA通过冻结原模型权重、仅训练低秩矩阵,将可训练参数量降低几个数量级。以ChatGLM3-6B为例,采用LoRA后&…

2026/11/19 16:30:28 阅读更多 →
八大网盘拿到真实直链:LinkSwift网盘直链解析工具实操指南

八大网盘拿到真实直链:LinkSwift网盘直链解析工具实操指南

八大网盘拿到真实直链:LinkSwift网盘直链解析工具实操指南 【免费下载链接】Online-disk-direct-link-download-assistant 一个基于 JavaScript 的网盘文件下载地址获取工具。基于【网盘直链下载助手】修改 ,支持 百度网盘 / 阿里云盘 / 中国移动云盘 / …

2026/11/20 11:00:54 阅读更多 →
教室人群头部检测数据集:YOLO格式单分类目标检测实操指南

教室人群头部检测数据集:YOLO格式单分类目标检测实操指南

简介:在计算机视觉领域,目标检测是许多上层应用的基础环节,而人头检测作为其中典型的单分类任务,在课堂行为分析、人数统计等场景中扮演着关键角色。YOLO系列模型凭借其高效的端到端检测能力,成为密集场景目标检测的主…

2026/11/21 12:42:20 阅读更多 →

最新新闻

Electron桌面应用开发实战:从环境搭建到打包发布全流程

Electron桌面应用开发实战:从环境搭建到打包发布全流程

做前端这些年,我大部分时间都在跟浏览器标签页打交道,直到第一次把桌面应用跑起来,才发现原来自己一直被限制在地址栏和刷新按钮围起来的框框里。Electron这个词,最开始是在某段时间频繁出现在同事的讨论里,一个用HTML…

2026/11/21 23:27:35 阅读更多 →
滑盖智能锁T109深度解析:结构原理、安装调试与故障排查

滑盖智能锁T109深度解析:结构原理、安装调试与故障排查

简介:亚太天能T109滑盖智能锁产品说明书是一份PDF格式的官方技术文档,主要面向智能锁安装人员、终端用户及售后维护者,帮助快速掌握产品安装、配置与常见故障处理。全包仅1个PDF文件,大小4.37MB,内容结构清晰&#xff…

2026/11/21 23:27:35 阅读更多 →
PMSM弱磁控制原理与Simulink建模:高速AGV驱动系统设计指南

PMSM弱磁控制原理与Simulink建模:高速AGV驱动系统设计指南

上个月我在调试一台高速AGV的驱动系统,整车要求空载跑到8m/s,电机转速已经拉到额定点,驱动器的输出电压也顶到了母线电压极限附近。再往上踩速度指令,转速纹丝不动,三相电流反而开始震荡。那会儿我的第一反应就是&…

2026/11/21 23:27:35 阅读更多 →
C++核心知识点:从内存管理到STL的实战指南

C++核心知识点:从内存管理到STL的实战指南

C 这门语言我前前后后折腾了十几年,用它写过嵌入式驱动、做过游戏服务端,也搭过基础组件库。每次看到新人一头扎进"C 核心知识点"这个搜索词,我其实挺感慨的——这门语言的难点从来不是语法多,而是知识点之间的耦合太深…

2026/11/21 23:27:35 阅读更多 →
T109滑盖智能锁怎么装?安装调试与故障排查全攻略

T109滑盖智能锁怎么装?安装调试与故障排查全攻略

简介:亚太天能T109滑盖智能锁产品说明书以PDF格式发布,适合智能锁用户、安装人员与售后维修人员阅读。内容围绕T109系列指纹密码刷卡锁展开,先介绍前面板、后面板、锁体、机械钥匙、电池盒盖等部件名称与功能,再给出完整安装步骤&…

2026/11/21 23:27:36 阅读更多 →
LLM知识降熵:从信息垄断到理解权下放

LLM知识降熵:从信息垄断到理解权下放

你有没有过这种经历:翻开源码注释、论文摘要或者一份专业报告,每个字都认识,连在一起却像天书。想找人聊聊,身边要么没人懂,要么懂的懒得跟你解释。后来我试着把同一段内容丢给一个大语言模型,几秒钟之后&a…

2026/11/21 23:27:37 阅读更多 →

日新闻

周新闻

月新闻