Stack Overflow
Stack Overflow

Questions tagged [docc]

Use this tag with questions about DocC, Apple's documentation compiler.

33 questions
8
votes
1 answer

How to link to documentation from another module/package in xcode docc?

I am trying to create articles in my docc in xcode. My project have multiple modules. For link to article within one module i have doc: markup. But i don`t understand, how link to article from another module. I am tryed use: …
Citrael
  • 542
  • 4
  • 17
6
votes
0 answers

How to export DocC documentation as PDF?

I have created a documentation for the SDK (DocC). I wanted to ask how to export SDK Documentation as PDF. Is there a way for that, if yes, how?
Rasul Mammadow
  • 69
  • 4
6
votes
3 answers

How to build DocC documentation from CLI

So I have been browsing the web for a while now and can't seem to find an answer on how to build the native DocC Xcode documentation using a CLI command. Both the xcodebuild commands and Fastlane do not provide a command to build the documentation -…
colin
  • 761
  • 1
  • 11
  • 24
4
votes
0 answers

Conditional directive in DocC for different platforms

Using DocC to document a swift package, is there a way to have conditional sections depending on whether you compile for iOS or macOS ? My problem is the following ; in a package, I have a symbol that is only valid while on macOS. If I refer to that…
AirXygène
  • 2,409
  • 15
  • 34
3
votes
0 answers

Apple DocC "BUILD DOCUMENTATION FAILED"

I'm trying to run xcodebuild docbuild using the following command to generate an Apple DocC .docarchive: xcodebuild docbuild -sdk iphoneos -project MyProject.xcodeproj -scheme MyProject -derivedDataPath ~/Desktop/MyProjectDocC The problem is with…
Mehrdad
  • 1,050
  • 1
  • 16
  • 27
3
votes
1 answer

DocC index shows a blank page when using MAMP

I am trying to perform a POC for the company I work to see the potential value we can get by using DocC in our project. Before my development, I saw the 4 videos related to DocC from WWDC 2021, visit Apple developer site and read some pages and…
Reimond Hill
  • 4,278
  • 40
  • 52
3
votes
1 answer

When using Apple DocC: How to not generate documentation? How to link to UIKit? How to generate docs for extensions?

I am using DocC for the first time, and after reading your docs, there are 4 things I don't know how to do it, can you help me? How can I mark public methods to tell DocC that I don't want to generate documentation for a specific method? For…
Ricardo
  • 2,831
  • 4
  • 29
  • 42
3
votes
3 answers

Running Xcode DocC without Apache Server/ (.htaccess)

In the DocC documentation, "Distributing Documentation to External Developers", Apple provided documentation to Host a Documentation Archive on Your Website. Unfortunately, when I open .doccarchive/index.html, I just get a white page. They have only…
Ben Butterworth
  • 22,056
  • 10
  • 114
  • 167
2
votes
0 answers

How do I make XCFramework documentation fully available in "Developer Documentation"?

I'm developing a fully documented framework. In its developing project, the documentation works perfectly. Although, when I add this framework to a project (with SPM or Cocoapods), if I option + click something defined in my framework I am not able…
gggava
  • 206
  • 2
  • 9
2
votes
1 answer

Running Xcode DocC documentation via Apache locally on macOS

Xcode 13's DocC documentation archives can be hosted using a custom Apache .htaccess file as described in Distributing Documentation to External Developers and Host and automate your DocC documentation - WWDC21. What are the steps to get that set up…
Ralf Ebert
  • 3,556
  • 3
  • 29
  • 43
1
vote
0 answers

Is it possible to distribute the documentation along with XCFramework?

I have develop a framework and I am able to generate documentation with DocC. When I include the .framework in the client app, I am able to see documentation when Option-Click on a method or property. However when I distribute the framework as…
smartsanja
  • 4,413
  • 9
  • 58
  • 106
1
vote
0 answers

Host a DocC documentation in a Next.js app

I want to add a DocC documentation to a specific path in my Next.js app (something like mydomain.com/documentation) but I'm a bit at a loss. There's a tutorial that tells you how to host the documentation on a server, but it uses a .htaccess file as…
SwiftedMind
  • 3,701
  • 3
  • 29
  • 63
1
vote
0 answers

Using DocC for an Objective-C project

I am working on an Objective-C library, that is also available via Swift Package Manager, namely Sentry. We want to generate API docs using DocC, but I am running into the problem where when I generate the documentation I get this error: error:…
Kevin Renskers
  • 5,156
  • 4
  • 47
  • 95
1
vote
0 answers

Package documentation using DocC failing to recognise catalogue

If I launch an existing Xcode project for a macOS target and create a new DocC catalogue, I get a basic template for a landing page asking for a summary and an overview etc. If I continue by adding a summary and an overview, then generate the…
bobby123uk
  • 892
  • 4
  • 17
1
vote
0 answers

Xcode 13 build an interactive tutorial

I have an app which is a little complicated to figure out details without a help document. I don't want to host the help document only on a web server for users who might not prefer to leave the app and go through the tutorial on a web page. So my…
erdo
  • 49
  • 3
1
2 3