如何从 CLI 构建 DocC 文档
How to build DocC documentation from CLI
所以我已经浏览了一段时间的网络,似乎无法找到关于如何构建 native DocC Xcode 文档 使用 CLI 命令。
据我所知,xcodebuild
命令和 Fastlane 都没有提供构建文档的命令。
文档应该在 CI/CDGithub 操作工作流程 中构建。如果有其他方法可以做到这一点,我们将不胜感激。
Apple 已向 xcodebuild
工具添加了一个新命令:
xcodebuild docbuild
您还可以查看 WWDC 演示文稿“托管和自动化您的 DocC 文档”。从 7:06 分钟 开始观看 DocC 自动化:https://developer.apple.com/videos/play/wwdc2021/10236/
为了补充最初的答案,我想在所有关于 DocC 的 WWDC21 视频中提到这个 complete summary,其中包含有关自动化的宝贵信息。
确实,Xcode13 中有一项新功能,用于通过包含 docbuild 操作 的命令行构建文档有许多可能的选项,如下所述。
即使@Colin 已经提供了解决方案,我认为附加一些对某些人可能至关重要的信息也很重要。
托管和自动化您的 DocC 文档 ☁️
Tl;博士
我为模块化项目调整了 xcodebuild docbuild
如下:
xcodebuild -project ModularSlothCreator.xcodeproj -derivedDataPath docsData -scheme ModularSlothCreator -destination 'platform=iOS Simulator,name=iPhone 13 Pro Max' -parallelizeTargets docbuild
我还使用 transform-for-static-hosting
标志调整了 docc
站点生成:
$(xcrun --find docc) process-archive transform-for-static-hosting "$ARCHIVE" --hosting-base-path ModularSlothCreator/$ARCHIVE_NAME --output-path docs/$ARCHIVE_NAME
奖励:使用 GitHub 页和 CI
自动化 DocC
我更新了在 WWDC 上展示的原始演示,支持 static hosting of modular App 目标(而不是仅支持在 WWDC 上宣布的单个 Swift 软件包)使用 GitHub 页面,无需为了方便在我的 blog post.
中定义服务器配置
所以我已经浏览了一段时间的网络,似乎无法找到关于如何构建 native DocC Xcode 文档 使用 CLI 命令。
据我所知,xcodebuild
命令和 Fastlane 都没有提供构建文档的命令。
文档应该在 CI/CDGithub 操作工作流程 中构建。如果有其他方法可以做到这一点,我们将不胜感激。
Apple 已向 xcodebuild
工具添加了一个新命令:
xcodebuild docbuild
您还可以查看 WWDC 演示文稿“托管和自动化您的 DocC 文档”。从 7:06 分钟 开始观看 DocC 自动化:https://developer.apple.com/videos/play/wwdc2021/10236/
为了补充最初的答案,我想在所有关于 DocC 的 WWDC21 视频中提到这个 complete summary,其中包含有关自动化的宝贵信息。
确实,Xcode13 中有一项新功能,用于通过包含 docbuild 操作 的命令行构建文档有许多可能的选项,如下所述。
托管和自动化您的 DocC 文档 ☁️
Tl;博士
我为模块化项目调整了 xcodebuild docbuild
如下:
xcodebuild -project ModularSlothCreator.xcodeproj -derivedDataPath docsData -scheme ModularSlothCreator -destination 'platform=iOS Simulator,name=iPhone 13 Pro Max' -parallelizeTargets docbuild
我还使用 transform-for-static-hosting
标志调整了 docc
站点生成:
$(xcrun --find docc) process-archive transform-for-static-hosting "$ARCHIVE" --hosting-base-path ModularSlothCreator/$ARCHIVE_NAME --output-path docs/$ARCHIVE_NAME
奖励:使用 GitHub 页和 CI
自动化 DocC我更新了在 WWDC 上展示的原始演示,支持 static hosting of modular App 目标(而不是仅支持在 WWDC 上宣布的单个 Swift 软件包)使用 GitHub 页面,无需为了方便在我的 blog post.
中定义服务器配置