如何从 CLI 构建 DocC 文档

Question

所以我已经浏览网页有一段时间了，似乎找不到有关如何构建本机 DocC Xcode 文档使用 CLI 命令的答案。

据我所知，

xcodebuild

命令和 Fastlane 都不提供构建文档的命令。

这些文档应该构建于CI/CD Github Actions 工作流程中。如果有其他方法可以实现此目的，我们将不胜感激。

Answer 1

Apple 在

xcodebuild

工具中添加了一个新命令：

xcodebuild docbuild

您还可以查看 WWDC 演示文稿“托管并自动化您的 DocC 文档”。从 7:06 分钟开始观看 DocC 自动化：https://developer.apple.com/videos/play/wwdc2021/10236/

Answer 2

托管并自动化您的 DocC 文档

️

Tl；博士

我针对模块化项目调整了 

xcodebuild docbuild

，如下所示：xcodebuild -project ModularSlothCreator.xcodeproj -derivedDataPath docsData -scheme ModularSlothCreator -destination 'platform=iOS Simulator,name=iPhone 13 Pro Max' -parallelizeTargets docbuild

我还使用 

docc

 标志调整了 

transform-for-static-hosting

网站生成：$(xcrun --find docc) process-archive transform-for-static-hosting "$ARCHIVE" --hosting-base-path ModularSlothCreator/$ARCHIVE_NAME --output-path docs/$ARCHIVE_NAME

奖励：使用 GitHub Pages 和 CI 自动化 DocC 🍀

我已经更新了 WWDC 上展示的原始演示，支持使用 GitHub Pages 的 modular App 目标的静态托管（而不是仅支持 WWDC 上宣布的单个 Swift 包），而无需定义服务器配置我的博客文章

很方便。

Answer 3

为了补充最初的答案，我想提一下有关 DocC 的所有 WWDC21 视频的完整摘要，其中包含有关自动化的宝贵信息。 🤓

事实上，Xcode 13 中有一个功能可以通过命令行构建文档，其中包括 docbuild 操作以及许多可能的选项，如下所述。 🤩 此外，Xcode 14 得益于其新的与大多数 Web 服务器的兼容性，促进了 DocC 存档内容在 Web 服务器根部的部署。 🤩
即使 @Colin 已经提供了解决方案，我认为附加一些对某些人来说可能至关重要的信息很重要。 😉

Answer 4

apple/swift-docc DocC 入门

提供 Swift-DocC 独立文档的命令行界面 (CLI) 信息。

### For Linux/macOS Swift Toolchain based installations:
docc --help

### For Xcode based installations:
xcrun docc --help

# OVERVIEW: Documentation Compiler: compile, analyze, and preview documentation.
# 
# USAGE: docc <subcommand>
# 
# OPTIONS:
#   -h, --help              Show help information.
# 
# SUBCOMMANDS:
#   convert                 Converts documentation from a source bundle.
#   index                   Create an index for the documentation from compiled data.
#   preview                 Previews documentation from a source bundle.
#   process-archive         Perform operations on DocC Archives.
# 
#   See 'docc help <subcommand>' for detailed help.