Author and share great documentation for your Swift packages and frameworks.

Posts under DocC tag

18 results found
Sort by:
Post not yet marked as solved
64 Views

CompileSwift normal x86_64 ( No such module 'SwiftyJSON')

Hello Team, I am using MacBook Pro (13-inch,M1,2020) chip Apple M1 and Xcode Version 12.4 (12D4e) with Swift Version 5, I am geting stuck with xcode issue which are given below. After installing Pods While Debugging Project we get **"No Such module 'SwiftyJSON' "** Error in whole project, Below are the ScreenShot Please Have a Look. If There is any solution please Let us know.
Asked
by Vickey.
Last updated
.
Post not yet marked as solved
76 Views

Can .doccarchive file enhance experience of code completion

In this documentation: distributing-documentation-to-external-developers, it seems that .doccarchive file can only be opened directly in Xcode or hosted in a website. In my circumstance, I am distributing my swift static framework by turning on BUILD_LIBRARY_FOR_DISTRIBUTION. There are some symbols such as struct/class/function/property, and they must be marked as public to meet the requirement of compiler. But I really discourage my clients to use these symbols. One of the approach is to remove them from the code completion suggestion of Xcode. In another documentation: documenting-a-swift-framework-or-package, it is said that: The compiler integrates directly with Xcode to enhance your existing workflow, including code completion, Quick Help, and more. I am wondering if it is possible that I ship my framework with a .doccarchive file. And when my clients use my binary framework, Xcode can use my .doccarchive file when doing code completion and showing quick help of the code?
Asked Last updated
.
Post not yet marked as solved
51 Views

Docc export to HTML

Is it possible to export interactive tutorial to html and use it on my website?
Asked
by Steve71.
Last updated
.
Post marked as Apple Recommended
270 Views

(How) Can I use DocC for internal documentation?

As presented in the talks and documentation I’ve seen so far, DocC works for public and open Swift symbols. But how about stuff for internal use? We are developing a fairly complex mixed source SDK with several components, that would benefit greatly from direct integration of auxiliary content for diagrams and so on. But since many of these parts are for internal use only, they have module or below level visibility. Is there a way to build an internal documentation target that includes this information with DocC, and — if so — how?
Asked Last updated
.
Post not yet marked as solved
92 Views

Can DocC Generate Documentation for Extensions?

Is there a way to force the documentation compiler to generate documentation for extensions to types outside a package/framework? This is incredibly important, as some packages and frameworks extend types that are part of the Swift Foundation (e.g., extensions to primitive types and collection) and SwiftUI (e.g., view modifiers and environment values).
Asked
by PRG.
Last updated
.
Post marked as solved
330 Views

How to host multiple docarchives on a single http server?

I have a few different projects and a ton of tutorials I want to host on the same http server... is this possible? I watched the Host and automate your DocC documentation session, but it seemed to only work with those rules for one docarchive. I know someone filed feedback for prefixes (https://developer.apple.com/forums/thread/682276)... is this possible already? Thanks.
Asked
by mhanlon99.
Last updated
.
Post marked as Apple Recommended
244 Views

Generate cross-platform documentation

Is is possible to use DocC to generate a single .doccarchive that contains documentation for multiple platforms, e.g. macOS and iOS? When publishing a package that has a lot of shared code but some differences between platforms it would be nice to not have to publish a website per-platform.
Asked Last updated
.
Post marked as Apple Recommended
310 Views

Unable to generate DocC documentation

Hi there! I've been trying to play around with the DocC documentation (amazing addition, my favourite for sure this year). Sadly, I'm not able to build documentation for the project. I'm running macOS 11.4 and the Xcode 13 beta (13A5154h). I've tried this on a couple of existing projects and a new fresh one. When I click product -> build documentation it will do a build action and open the documentation for the page I had open last and show all Apple documentation, but I am unable to see any documentation for my project. I am able to add a documentation catalog. That creates the 'index' and a resources folder, which is empty. Is this a known issue, or an issue on my end?
Asked
by iikeli.
Last updated
.
Post marked as solved
117 Views

Is there a way to include snippets from an external file with DocC?

I have a few sections in my content where I have a repeated example that I use to illustrate how to use a few methods in my library together - is there a way to move this into an external snippet and include it inline within existing content?
Asked
by heckj.
Last updated
.
Post marked as Apple Recommended
209 Views

docarchive can't be rendered with local python web server

Exported a docarchive. Then at command line, went into the directory and ran $ python3 -m http.server to start local web server. Pointing Safari 14.1.1 at the address http://localhost:8000/index.html and I see error message "The page you’re looking for can’t be found." Any guidance?
Asked
by cctile.
Last updated
.
Post marked as Apple Recommended
134 Views

Can we use DocC to compile Documentation for Apps?

Can we use DocC to compile Documentation for Apps?
Asked
by AJNadeem.
Last updated
.
Post marked as Apple Recommended
137 Views

Is it possible to specify the build target for DocC? (I want to exclude libraries installed with CocoaPods)

I tried to use DocC to generate documentation, but apparently DocC also tried to generate documentation for the library source code. I would like to know how to avoid this behavior. Thank you.
Asked
by zuu.
Last updated
.
Post marked as Apple Recommended
152 Views

Does DocC support SVG?

Thanks for making DocC. It looks great. Does it support rendering an SVG image?
Asked
by cctile.
Last updated
.