问题标签 [jazzy]

我正在尝试创建 Xcode 项目的文档，但遇到了一个非常奇怪的问题，我无法解决。

我下载了 Jazzy 作为创建文档的工具。我评论/记录了几个没有问题的文件，但有一个文件就无法解析它。我已经阅读了几个 Github 和 StackOverflow 线程，但没有一个能解决我的问题。我尝试弄乱访问级别标志，强制包括甚至从 jazzy 中排除文件并重新安装整个 jazzy。以上都没有奏效。

当我尝试在我的项目中运行jazzy --min-acl internal（或只是任何访问级别或只是jazzy）时，它会解析 13/39 个文件。在 14 号它停止并抛出此错误：

这一切都让我感到困惑，因为事先知道一切都很好。这意味着我破坏了某些东西，我不知道更改任何设置。我只是在编写文档的过程中更改了一些代码。但是，这似乎真的很奇怪，这就是它背后的原因。此外 - 已经记录的文件工作得很好，只是这个没有。

任何提示或帮助将不胜感激！谢谢

我想将指向我们主要文档页面的链接添加到每个 jazzy 生成的页面。谁能指出我实际构建 html 的代码？我查看了所有自定义选项，但没有一个能满足我的要求。我也浏览了一段时间的代码，但到目前为止还没有找到我需要编辑的内容。

我已经能够在本地为我的 iOS/swift 项目和框架制作精美的文档。我想通过 Fastlane 开始制作它们，以便在构建 Jenkins 工作时自动更新它们。

我还没有找到任何关于将 jazzy 与 Fastlane 或 Jenkins 结合的好的文档。

有没有人可以分享任何好的教程或回购示例？此外，我希望能够在我的 Fastfile 或配置文件中传递一些内容，将其上传到 S3 存储桶。

所以我试图运行 Jazzy 来记录我的代码，但我并没有走得太远。

这就是当我在我用 swift 编写的 Xcode 项目上运行 Jazzy 时发生的事情（以及 @objc 中的一些函数）。我需要以任何方式准备项目吗？我找不到任何关于此的信息，但这是我第一次使用 Xcode 和 jazzy。谁能告诉我为什么它不能正常运行我在运行命令时做错了什么？

我尝试做 jazzy --min-acl 但发生了这种情况：

我尝试在 xcode 11.3 中为我的项目运行 jazzy，我得到了

运行 xcodebuild 无法成功运行xcodebuild。请检查构建参数。bundler：加载失败命令：jazzy RuntimeError：/Users/germanmendoza/Desktop/CI-Demo/vendor/bundle/ruby/2.6.0/gems/jazzy-0.13.2/bin/sourcekitten ["doc", "-- "]

无法生成文档

日志有

我有一个使用 SPM（并且不使用 cocoapods）的项目。它编译并运行良好。

我可以从命令行运行 SwiftLint 自动更正，这也可以。

但是，当我尝试在它上面运行 jazzy 时，我收到了这个错误：

致命错误：找不到模块映射文件'/Users/Alex/Library/Developer/Xcode/DerivedData/Answers-akfeigwudbzjrkewvufnejnpluej/SourcePackages/checkouts/realm-cocoa/buil d/GeneratedModuleMaps/iphoneos/RealmCore.modulemap'

我经历了许多类似问题的“修复”：我更新了系统首选项以允许终端访问开发者工具等。

jazzy 命令适用于我的其他项目，其中一些使用 SPM，这让我有点困惑。作为一种解决方法，我将删除 SPM 并使用 carthage 创建我需要的 Realm 和 RealmSwift 框架。

对于完成者：

命令行调用：

2 /Applications/Xcode.app/Contents/Developer/usr/bin/xcodebuild -target Answers -sdk iphoneos
3
4 从命令行构建设置：
5 SDKROOT = iphoneos13.4
6
7 解决包图
8
9 解决的源包：
10 领域: https://github.com/realm/realm-cocoa.git @ 4.4.1
11 Alamofire: https://github.com/Alamofire/Alamofire.git @ 5.1.0
12 RealmCore: https://github.com /realm/realm-core @ 5.23.8
13
14
15 注意：使用新的构建系统
16 注意：计划构建
17 注意：使用磁盘中的构建描述
18 CompileC /Users/Alex/Library/Developer/Xcode/DerivedData/Answers-akfeigwudbzjrkewvufnejnpluej/SourcePackages/checkouts/realm-cocoa/build/Realm.build/Release -iphoneos/Realm.build/Objects-normal/arm64/collection_notifications.o /Users/Alex/Library/Developer/Xcode/DerivedData/Answers-akfeigwudbzjrkewvufnejnpluej/SourcePackages/checkouts/realm-cocoa/Realm/ObjectStore/src/collection_notifications.cpp normal arm64 c++ com.apple.compilers.llvm.clang.1_0.compiler （在项目“领域”的目标“领域”中）
19 cd /Users/Alex/Library/Developer/Xcode/DerivedData/Answers-akfeigwudbzjrkewvufnejnpluej/SourcePackages/checkouts/realm-cocoa

20 导出 LANG=en_US.US-ASCII

build/Release-iphoneos/Realm.build/DerivedSources -F/Users/Alex/Library/Developer/Xcode/DerivedData/Answers-akfeigwudbzjrkewvufnejnpluej/SourcePackages/checkouts/realm-cocoa/build/Release-iphoneos -F/Applications/Xcode。应用程序/内容/开发人员/平台/iPhoneOS。platform/Developer/Library/Frameworks -fmodule-map-file=/Users/Alex/Library/Developer/Xcode/DerivedData/Answers-akfeigwudbzjrkewvufnejnpluej/SourcePackages/checkouts/realm-cocoa/build/GeneratedModuleMaps/iphoneos/RealmCore.modulemap -DXcode -MMD -MT 依赖项 -MF /Users/Alex/Library/Developer/Xcode/DerivedData/Answers-akfeigwudbzjrkewvufnejnpluej/SourcePackages/checkouts/realm-cocoa/build/Realm.build/Release-iphoneos/Realm.build/Objects-normal/ arm64/collection_ 通知。
22 致命错误：找不到模块映射文件“/Users/Alex/Library/Developer/Xcode/DerivedData/Answers-akfeigwudbzjrkewvufnejnpluej/SourcePackages/checkouts/realm-cocoa/buil d/GeneratedModuleMaps/iphoneos/RealmCore.modulemap”
23 警告：可能未读取序列化诊断文件：无法加载文件：无法打开诊断文件（在项目“领域”的目标“领域”中）

有人认识这些症状吗？

我正在尝试在使用 Swift 包的项目上使用 Jazzy，但由于该包而失败。有谁知道如何让它忽略它们。我尝试了许多选项，但没有一个有效。

我创建了一个新项目 [在安装 pod 之前]。我正在尝试使用jazzy创建文档，它创建得很好。

我在终端中使用的推荐

然后我安装了 pod 文件并尝试在终端中使用相同的命令，当时我遇到了类似的错误

我正在尝试生成一些文档。我的项目使用 Jazzy。但是，当我从命令行运行时jazzy，我得到以下输出：

为什么从 xcode 我的项目构建没有问题时运行失败

我正在尝试使用 Jazzy 为我的 xcode 项目创建文档。我能够从我的根文件夹成功运行 xcodebuild，但只能使用以下参数：

如果不使用这些参数，我会收到大量构建错误。

因此，当我jazzy从根目录在命令行中自行运行时，显然我遇到了问题，因为 xcodebuild 无法运行。所以我相信我也需要将这些参数添加到我的 jazzy 命令中。

我已经尝试过使用：

还有：

但在这两种情况下，我都遇到了这个错误：

不知道从这里去哪里，任何帮助将不胜感激。