Finally succeeded in generating HTML documentation for a Swift Package containing several targets, with cross references.
Feature still experimental, customisation is still a chore, but it just works.
Thanks to the community  

#Swift #SwiftUI #SwiftDocC #SwiftPackage #GitHub
#iOS #iosdev #DesignSystem #opensource

https://ios.unified-design-system.orange.com/documentation/

Documentation

this works for any documentation you generate with Swift-DocC! you would use the forward-slash key (/) instead for your own docs, but the feature is the same!

#swiftlang #SwiftDocC https://mastodon.social/@schwa/114106083641317923

if you have an existing link to one of our GitHub Pages docs renderings, that won't automatically redirect like the repo will, so you'll need to change `apple.github.io` to `swiftlang.github.io` in your URL.

we have some links in the Swift-DocC repo that need to be updated as soon as our CI is back online 😅 #SwiftDocC #Swift

#SwiftDocC and its sister repos have all been moved to github.com/swiftlang! https://github.com/swiftlang/swift-docc #Swift
GitHub - swiftlang/swift-docc: Documentation compiler that produces rich API reference documentation and interactive tutorials for your Swift framework or package.

Documentation compiler that produces rich API reference documentation and interactive tutorials for your Swift framework or package. - swiftlang/swift-docc

GitHub
is it ready to ship? no. for one, i still need to write tests, but also the frontend stuff i changed is probably a pile of terrible hacks because i'm not actually a frontend dev lol #SwiftDocC #Swift

okay so i'm legit proud of this work

so i've been working on combining overloaded methods into a single “overload group" in curation and navigation. the work is currently landed on main and release/6.0, but right now it will just list all the overloaded symbol declarations on the page without showing you what's actually distinct between them

until now https://github.com/apple/swift-docc/pull/928

#SwiftDocC #Swift

Highlight declaration differences in overloaded symbol groups by QuietMisdreavus · Pull Request #928 · apple/swift-docc

Bug/issue #, if applicable: rdar://116409531 Summary This PR introduces a new field to declaration tokens in Render JSON: highlight. This field indicates that the token is distinct among a set of o...

GitHub

I recently moved the #Adwaita for #Swift docs to #SwiftDocC. So much thanks to the developers of #DocC, it makes maintaining docs extremely easy!

https://aparokshaui.github.io/adwaita-swift/documentation/adwaita/

There's also a beginner tutorial available that walks you through the creation of a #GNOME to-do manager app. It still needs some polishing though. I highly appreciate any form of feedback!

https://aparokshaui.github.io/adwaita-swift/tutorials/table-of-contents

#gtk #libadwaita #swiftui #swiftlang

Documentation

periodic reminder that Swift-DocC is not necessarily just for documenting Swift and Objective-C code - it doesn't even directly hook into either compiler at all! Marcus ultimately converted the Swift-DocC-Render component hierarchy into a "symbol graph", which Swift-DocC itself uses as the input data for API documentation

theoretically anything that could be represented like this could be used as a data source for DocC documentation, though i will admit that there are some assumptions about the way symbols work in DocC itself today

regardless, this is rad as heck

#Swift #SwiftDocC

here's a cool little project: one of the maintainers of Swift-DocC-Render, the Vue.js frontend for documentation generated with Swift-DocC, wrote up a way to use tree-sitter to generate DocC documentation for DocC-Render! https://github.com/apple/swift-docc-render/pull/746

#Swift #SwiftDocC

Start documenting components with DocC using in-source comments by mportiz08 · Pull Request #746 · apple/swift-docc-render

Bug/issue #, if applicable: 117215034 Summary This adds a script to generate a "symbol graph" JSON file, which can be used to document Swift-DocC-Render using Swift-DocC itself. Specifically, this ...

GitHub

And another one! https://github.com/apple/swift-format/pull/615

The rules available in #swift-format are documented now (markdown on GitHub for now, I’ll move them into a #swiftdocc bundle later this weekend): https://github.com/apple/swift-format/blob/main/Documentation/RuleDocumentation.md

And the neat part is that the documentation is automatically generated from the rules source code!

Generate rule docs automatically by natikgadzhi · Pull Request #615 · apple/swift-format

Summary First step of #606, adds documentation for the list of available rules in Documentation directory. Changes Adds a generate-pipeline generator RuleDocumentationGenerator that extracts eac...

GitHub