标签: docc

如何从 xcode docc 中的另一个模块/包链接到文档?

我正在尝试在 xcode 中的文档中创建文章。我的项目有多个模块。

对于一个模块中文章的链接,我有文档:markup。但我不明白如何链接到另一个模块的文章。

我尝试使用:

 <doc:../../AnotherModule/AnotherModule.docc/Article>
 <doc:../../AnotherModule/AnotherModule.docc/Article.md>
 <doc:../../AnotherModule/AnotherModule/Article>
 <doc:../../AnotherModule/AnotherModule/Article.md>
 <doc:../../AnotherModule/Article>
 <doc:../../AnotherModule/Article.md>

Run Code Online (Sandbox Code Playgroud)

但所有这些都不起作用。

xcode ios docc

9
推荐指数
1
解决办法
877
查看次数

如何将DocC文档导出为PDF?

我已经为 SDK 创建了文档 (DocC)。

我想问一下如何将SDK文档导出为PDF格式。有没有办法,如果有的话,怎么办?

documentation xcode swift docc

7
推荐指数
0
解决办法
495
查看次数

如何从 CLI 构建 DocC 文档

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

xcodebuild据我所知,命令和 Fastlane 都不提供构建文档的命令。

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

xcode continuous-integration xcodebuild docc

6
推荐指数
1
解决办法
2459
查看次数

使用 MAMP 时 DocC 索引显示空白页

我正在尝试为我工作的公司执行 POC,以了解在我们的项目中使用 DocC 可以获得的潜在价值。

在开发之前,我看了 WWDC 2021 上与 DocC 相关的 4 个视频,访问了Apple 开发者网站并阅读了一些页面和博客来收集一些信息和想法。

对于我的开发,我开始在我的开发计算机上使用 MAMP,然后将工作推送到服务器。

到目前为止,我认为我已经完成了在网站上托管文档存档的所有必要步骤。然而,我想知道我是否错过了一些东西,因为我的index.html 看起来是空白的。

我使用的代码是:

index.html(主要)

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>DocC POC</title>
</head>
<body>
    <h2>Welcome</h2>
    <button onclick="location.href = 'documentation/index.html';" id="myButton" class="float-left submit-button" >Read data framwework documentation</button>
</body>
</html>
Run Code Online (Sandbox Code Playgroud)

.htaccess

# Enable custom routing.
RewriteEngine On
# Route documentation and tutorial pages.
RewriteRule ^(documentation|tutorials)\/.*$ Data.doccarchive/index.html [L]
# Route files and data for the documentation archive.
#
# If …
Run Code Online (Sandbox Code Playgroud)

xcode mamp docc

6
推荐指数
1
解决办法
335
查看次数

是否可以将文档与 XCFramework 一起分发?

我已经开发了一个框架,并且能够使用DocC生成文档。当我在客户端应用程序中包含 .framework 时,我可以在按住 Option 键单击方法或属性时看到文档。但是,当我将框架作为 XCFramework 分发并包含在客户端应用程序中时,当 Option-Click 方法或属性时,Xcode 不会显示任何文档。当我检查 XCFramework 时,有一个名为“arm64-apple-ios.swiftdoc”的文件似乎包含文档。但它不是任何地方都可以访问的。

我仍然无法在互联网上找到任何资源。如果可以随 XCFramework 一起携带文档,请分享如何执行此操作。任何帮助深表感谢。

xcode ios swift xcframework docc

5
推荐指数
0
解决办法
146
查看次数

如何使用 Docc 在 GitHub 上发布?

我有一个托管在 的 SPM 包https://github.com/janodev/foobar

如何使用 Docc 生成文档并将其托管在 GitHub 上?

ios swift swift-package-manager docc

2
推荐指数
1
解决办法
746
查看次数

如何在 Apple DocC 上添加字符串扩展

我正在检查有关 的新 Apple 文档Xcode 13 beta。我可以build documentation用DocC。

但我看不到为字符串扩展、日期扩展等扩展创建的任何文档。

根据下面的示例,它不会添加任何文档。

extension String {

    /// Description for DocC
    func myMethod() {
       
    }
}
Run Code Online (Sandbox Code Playgroud)

考虑一下,如果我为任何结构或类创建了扩展,那么它就会添加如下代码所示的文档

public struct MyStruct {

}


extension MyStruct {

  /// Description
  func myMethod() {
 
  }
}
Run Code Online (Sandbox Code Playgroud)

这是苹果的默认行为还是我遗漏了什么?

xcode ios swift xcode13 docc

1
推荐指数
1
解决办法
578
查看次数