Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[SR-15434] [Swift-DocC] Support custom documentation module kinds #207

Closed
ethan-kusters opened this issue Nov 3, 2021 · 2 comments
Closed
Assignees
Labels
improvement

Comments

@ethan-kusters
Copy link
Contributor

ethan-kusters commented Nov 3, 2021

Previous ID SR-15434
Radar rdar://83448323
Original Reporter @ethan-kusters
Type Improvement
Status Resolved
Resolution Done
Additional Detail from JIRA
Votes 2
Component/s Swift-DocC
Labels Improvement
Assignee @ethan-kusters
Priority Medium

md5: 6206e14f17a5fa158306a795d8f034f6

Issue Description:

Swift-DocC currently describes every documentation catalog it produces as a “Framework”.

For example, DocC’s own user-facing documentation at https://swift.org/documentation/docc/ is currently incorrectly described as a “Framework”.

While SwiftDocC is a framework, the documentation hosted at https://swift.org/documentation/docc/ is documentation explaining how to use DocC as a tool; it is not documentation of the SwiftDocC framework.

Swift-DocC should be enhanced to allow documentation authors to provide custom text to describe the thing they are documenting. This should allow the DocC user-facing documentation to describe itself as a “Documentation Tool” instead of as a “Framework”. This should also allow for build systems that integrate with DocC to accurately produce documentation for other product types, like executables.

@ethan-kusters
Copy link
Contributor Author

ethan-kusters commented Nov 11, 2021

[[SR-15434] Add support for custom (non-framework) module kinds|#33]

@ethan-kusters
Copy link
Contributor Author

ethan-kusters commented Jan 4, 2022

0752acf

@swift-ci swift-ci transferred this issue from apple/swift-issues Apr 25, 2022
@shahmishal shahmishal transferred this issue from apple/swift May 3, 2022
This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
improvement
Projects
None yet
Development

No branches or pull requests

1 participant