Create a generate-documentation package subcommand #9338
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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
force-pushed
the
docc_subcommand
branch
from
4fae266 to
74db91b
Compare
…ager into docc_subcommand
|
@swift-ci please test |
|
@swift-ci please test |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.