Skip to content

Create a generate-documentation package subcommand #9338

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.

Sign up for GitHub

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

Jump to bottom
Draft
wants to merge 4 commits into
base: main
Choose a base branch
from
Draft

Create a generate-documentation package subcommand #9338

wants to merge 4 commits into from

Conversation

@cmcgee1024
Copy link
Member

@cmcgee1024 cmcgee1024 commented Nov 5, 2025

This change proposes a package documentation generation subcommand that is capable of
generating a DocC archive that encompasses a variety of different targets and target types
of a SwiftPM package.
@cmcgee1024
SwiftPM generate-documentation subcommand
74db91b 
Create a subcommand that's capable of generating DocC documentation for a package, including its targets. Support natively the ability to document executable targets using the tool info dump facility available in the Swift Argument Parser and potentially others that conform to its protocol. Allow any target regardless of its type to include a DocC catalog of markdown files to document its target. This includes ones that don't normally have a mechanism to generate its own API reference. Provide an option to generate the internal facing documentation for a Package, including all of its targets, even ones that are not exported as products.
@cmcgee1024
Copy link
Member Author

cmcgee1024 commented Nov 5, 2025

@swift-ci please test
@cmcgee1024
Copy link
Member Author

cmcgee1024 commented Nov 6, 2025

@swift-ci please test
@cmcgee1024
Copy link
Member Author

cmcgee1024 commented Nov 7, 2025

@swift-ci please test
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

1 participant

@cmcgee1024