#Docs for xcode archive#
The archive is not just one thing, it contains three things: The Three Kings Things (in a DocC Archive) They also said that they are going to provide a hosting service forĭocumentation, we’ll see how that works out. It’s also worth mentioning that Apple said to release DocC itself as open To understand why, we have to look at the exported DocC Archive I disagree, DocC is not useless for open source projects. This issue resulted in some serious backslash like:Īpple’s DocC is excellent, but unusable for open source projects. Long story short: To open a DocC Archive in the browser, you Using DocC to document just Xcode projects, not Swift Packages.Īnd that all the docs are hosted internally on a central I suspect the reason this happened is that Apple itself is It’s funny how it could have possibly happened that such a Open the documentation in the browser, NOT 🤦♀️ Just open the index.html file in the DocC Archive and it’ll The big fancy, official feature being: It contains HTML and supportingįiles to show your site in a web browser, $ ls ~/Downloads/SlothCreator.doccarchive/ĭata favicon.svg index theme-settings.json “Show Package Contents” in Finder’s context menu). Just a directory structure containing an export of yourĭocumentation (you can look at it by choosing The DocC ArchiveĪ DocC Archive appears as an opaque file in Finder, but it is
That “export” is creating a “DocC Archive” and that happens to be Host and automate your DocC documentation. It can also be automated using xcodebuild, which is covered in We are going to look at something else, this feature: It supports quite a lot of things and you can learn more aboutĭocumenting a Swift Framework or Package. Which can enhance the source documentation of a target w/ additional (you can also trigger the action using theĭocC is working together w/ the Swift compiler infrastructure toĮxtract the API of a Swift target and its documentation comments.Ī target can also (optionally!) include a Going to produce documentation for all targets in your project.Īnd open that in the Xcode documentation viewer In Xcode 13 you just have to press Ctrl-Shift-Cmd-D and it is
Let’s still revisit what the user facing part does. We are not going to look on how DocC documentation and tutorialsīut rather on what the output of DocC is. File:///tmp/SlothCreatorSite/documentation/slothcreator/index.html.
0 kommentar(er)
