Use this tag with questions about DocC, Apple's documentation compiler.
Questions tagged [docc]
33 questions
1
vote
1 answer
Is it possible to build a `.docc` catalog from the CLI?
When I build documentation in Xcode with Ctrl-Cmd-Shift-D, it includes my .docc catalog. When I run xcodebuild docbuild from the command line, it doesn't.
Why is this? Is it possible to tell xcodebuild to use a specific .docc catalog rather than…

Bbrk24
- 739
- 6
- 22
1
vote
0 answers
Xcode 13.3 Build DocC Command CompileDocumentation failed with a nonzero exit code
Xcode Build DocC Document with Product-Build Documentation failed
Command CompileDocumentation failed with a nonzero exit code

heindelssohn
- 11
- 1
1
vote
1 answer
DocC documentation archive not recognised by Xcode in a CocoaPod
While developing the internal project for a CocoaPod, I can successfully add a .docc documentation archive, build documentation and see the changes reflected in the Xcode documentation viewer. However, when I include the pod in another project (and…

Amja
- 1,315
- 9
- 25
1
vote
1 answer
How can I publish on GitHub using Docc?
I have an SPM package hosted at https://github.com/janodev/foobar.
How can I generate documentation with Docc and host it at GitHub?

Jano
- 62,815
- 21
- 164
- 192
1
vote
0 answers
DocC documentation can't be rendered with Apache on CentOS 7
I downloaded the sample code project 'SlothCreator' from here then exported a SlothCreator.doccarchive file.
I placed the SlothCreator.doccarchive in /var/www/html/.
My .htaccess file is as follows.
# Enable custom routing.
RewriteEngine On
# Route…

wonconn
- 11
- 2
1
vote
1 answer
How to add String Extension on Apple DocC
I am checking new Apple documentation on Xcode 13 beta. I am able to build documentation with DocC.
But I am not able to see any documentation created for extensions like String extension, Date extension.
As per example for below case it will not…

PJR
- 13,052
- 13
- 64
- 104
0
votes
1 answer
Swift Doc-C - Selective data for documentation
Is it possible to select specific classes or structs for documentation ? As of now when I hosted my static website using doc-c command line it pulled up all the public methods for the sake of documentation.
Is it possible that I can select what…
user1845926
0
votes
1 answer
Unable to build documentaion using docc preview FILE.docc
While working with a Swift Documentation file, when I run docc preview FILE.docc, the console shows an error:
zsh: command not found: docc
Which I know why as docc binary is not available in my documentation workspace. So I cloned the docC repo,…

Ekoreh
- 3
- 1
- 3
0
votes
0 answers
How can I include Swift documentation in a Private CocoaPod .xcframework?
I have created a Swift library where I added a documentation (with /** */ or ///). This documentation works when I work on the main project. But I need to export the library in a Private CocoaPod Github repo in a .xcframework (pre-compiled). When I…
0
votes
0 answers
DocC (Apple documentation compiler) resize image
I am displaying an image in the docs like this.

But the image is too big.
I would like to resize it. Any suggestion?
The image is located in the Resources directory of the documentation.

Sergio
- 1,610
- 14
- 28
0
votes
0 answers
Can DocC interactive tutorials be hosted?
I'm exporting and hosting DocC documentation successfully on GitHub pages for my Swift framework yet the interactive tutorials I've written don't seem to be accessible.
I've tried multiple different urls /documentation/myframework/tutorials/,…

pinglock
- 982
- 2
- 12
- 30
0
votes
0 answers
Xcode 14, how do I tell DocC to include private functions?
I have a project that I would like to document for future reference. Is there a way to tell DocC to include private and internal functions like you can in Jazzy?

Jorgen
- 465
- 3
- 10
- 24
0
votes
0 answers
Adding user registration to a DocC Tutorial with assessment
I've created an interactive Swift DocC Tutorial with multiple choice assessments. Now I want to add a user registration so that I can keep tab of who has completed the tutorial. How might I do this? Specifically:
How do I make sure they answer all…

newbie py
- 53
- 1
- 5
0
votes
0 answers
error: the use of documentation catalogs is not supported in the legacy build system
I have one framework target in my project. I generally share this framework in xcframework form with my end customers. One of them is still working with legacy build system in Xcode. Treating them special, I was trying to provide same framework…

Sauvik Dolui
- 5,520
- 3
- 34
- 44
0
votes
1 answer
GitHub Pages Deployment Failure with my DocC project
I'm trying to push DocC to my GitHub Pages, I'm following tutorials on DocC documentation.
What I'm done till now is in my SPM directory I'm using these commands in terminal:
xcodebuild docbuild -scheme (schema-name) -derivedDataPath…

Reza Khonsari
- 479
- 3
- 13