Error while generating a DocC based documentation for a Swift Package

Question

Created Jul ’22

Replies 1

Boosts 0

Views 1.5k

Participants 2

I want to generate a DocC documentation for an internal Swift Package with the help of SwiftDocC plugin using the following command:

The internal framework uses realm-core and realm-cocoa.

$ swift package --disable-sandbox preview-documentation --product InternalFramework

Actual Results

If I build the DocC files via Xcode the build documentation is generated. But if I use the above command on the terminal to generate.

There is an error shown on the terminal and the framework fails to build the documentation.

The following is the error shown on the terminal

Computing version for https://github.com/realm/realm-cocoa.git
Computed https://github.com/realm/realm-cocoa.git at 10.28.1 (0.64s)
Computing version for https://github.com/realm/realm-core
Computed https://github.com/realm/realm-core at 12.1.0 (0.36s)
error: Couldn’t update repository submodules:
    fatal: could not get a repository handle for submodule 'tools/vcpkg/ports'

I do not understand whether it is a DocC based issue or a realm issue.

Steps & Code to Reproduce

Running the following command causes the error:

$ swift package --disable-sandbox preview-documentation --product InternalFramework

I am not able to understand the root cause of the error.

Boost

Answer 1

Engineer OP

Apple

Jul ’22

This sounds like it may be a general Swift Package Manager dependency resolution issue. If you see the same error when you try to build from the command-line using:

$ swift build --product InternalFramework

then I would recommend either opening an issue on the open-source Swift Package Manager repository or filing a Feedback.

0