CocoaDocs 文档日落

TL;DR:CocoaDocs 将在 5 月底停止为使用 CocoaPods 的新库和版本生成 DocSets。

我在 CocoaDocs 2013 年 2 月开始,并已运行和维护了 4 年。CocoaDocs 最初是通过 Appledoc 为 Objective-C 项目生成文档的一种方式。当 Swift 出现时,Jazzy 支持添加到应用程序中。从那时起,CocoaDocs 多年来已逐渐发展成为一种工具,用于 生成有用的元数据,用于 CocoaPods.org 网站中的任何 CocoaPods 库。

我打算在 5 月底之前删除为上传到 trunk 的新库生成 HTML 页面和 DocSets 的支持。

我想降低 CocoaDocs 的复杂性。如果没有一两个问题,CocoaDocs repo 中关于特定库或工具设置的一周是很少见的,这些问题需要服务器上的人工干预。这些问题要么来自 Xcode 本身,要么来自依赖于 Xcode 基础设施来完成工作的工具。这使得整体修复变得困难。

通过删除系统中的这些部分,我可以继续维护 CocoaDocs 中使用最多的方面:为 CocoaPods.org 创建指标(用于搜索)和 README/CHANGELOG 摘要。

我认为将 CocoaDocs 的维护任务交给 CocoaPods 的其他贡献者是不公平的。这是一个复杂的工具,需要在不相关的领域拥有很多独特的知识。

因此,我认为对于其他人来说,现在是重新考虑 CocoaDocs 的原始前提并创建既适用于 Swift Package Manager 又适用于 CocoaPods 的东西的好时机。我听说服务器端 Swift 正在成为一种趋势,所以也许你可以用它为社区创建一个新服务?

由于 Cocoa 项目编译需要很长时间,你最终可能会采用与 CocoaDocs 相似的架构。这意味着创建一个简单的 REST 服务器,它提供一个类似队列的基础设施来解析文档,并将结果上传到静态资产主机。在这种情况下,CocoaDocs 使用 S3,每月费用约为 20 美元。

如果你决定尝试一下,一旦你有了原型,请告诉我,我会很乐意提供尽可能多的资源。我们还可以从 CocoaPods Trunk 设置 Web 钩子。