将文档转换为docset格式。
项目描述
doc2dash
doc2dash是一个可扩展的文档集 (docset) 生成器，它可以帮助您拥有所有喜爱的API在Dash兼容的 API浏览器中的文档。
API浏览器是一个在您的计算机上本地运行的应用程序，允许您通过按组合键并开始输入来搜索各种API文档（我将其绑定到⌥Space栏，没有它我无法编写代码）。
最常见的是 – Dash (macOS) 和 Zeal (Windows和Linux) – 默认提供许多docset，但它们永远无法为您使用的每个包提供docset。这就是doc2dash发挥作用的地方：它将您的离线文档转换为API浏览器可以读取和搜索的索引格式（非常快！）。
目前它支持所有已知的基于intersphinx的文档系统，如Sphinx、pydoctor或MkDocs（带有mkdocstrings）。虽然doc2dash是一个Python项目，但支持并不仅限于Python相关格式。
它也是可扩展的：您可以编写自己的解析器！
快速入门
开始最快的办法是安装我们的doc2dash，方法是从Homebrew tap安装。
$ brew install hynek/tap/doc2dash
然后，将doc2dash指向包含intersphinx-兼容文档的目录。
$ doc2dash directory/to/documentation
您应该会看到上面视频中的输出，并在当前目录中找到一个命名适当的docset。就是这样 - 您可以将它添加到Dash或Zeal！
doc2dash具有更多功能和选项 - 请务必查看使用说明获取更多详细信息。完整的教程也可用。
鸣谢
doc2dash由Hynek Schlawack维护，并使用MIT许可证发布。
开发得到了我的雇主Variomedia AG和所有我的惊人的GitHub Sponsors的友好支持。
发布信息
新增
-
支持使用
--icon-2x选项使用高分辨率图标。 #200 -
支持使用
--playground-url选项链接到docset playgrounds。 #201
修复
- 已恢复基于pydoctor的文档的目录表生成。 #133
下载文件
下载适合您平台的文件。如果您不确定该选择哪个，请了解有关安装包的更多信息。
源分布
构建分布
doc2dash-3.1.0.tar.gz的散列
| 算法 | 散列摘要 | |
|---|---|---|
| SHA256 | 37f61c8d8f6a955d2466b9c073eb2bff44cc54352bf817afb48a3ac8aef6d594 |
|
| MD5 | 050c22e017d874233a6b4ebaa97c61ac |
|
| BLAKE2b-256 | ba41e5eda8e3fff9d1c86345fe040f2de004918006a49dfe1bec41ea6bc0638a |