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

chore(deps): update dependency apple/swift-docc-plugin to from: "1.4.3" #96

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Sep 12, 2024

This PR contains the following updates:

Package Update Change
apple/swift-docc-plugin minor from: "1.0.0" -> from: "1.4.3"

Release Notes

apple/swift-docc-plugin (apple/swift-docc-plugin)

v1.4.3: Swift-DocC-Plugin 1.4.3

Compare Source

What's Changed
  • Fixes a bug with the experimental combined documentation feature where targets with multiple dependencies wasn't able to link to all their dependencies' documentation.

  • Support generating Swift documentation for C/C++/Objective-C targets.


The 1.4.3 release includes contributions from @​cmcgee1024, @​sofiaromorales, and @​d-ronnqvist. Thank you!

v1.4.2: Swift-DocC-Plugin 1.4.2

Compare Source

What's Changed

Fixes a build failure for Swift versions 5.7 and 5.8.

Swift versions 5.6 and earlier are not supported, and Package.swift now reflects this as expected.

v1.4.1: Swift-DocC-Plugin 1.4.1

Compare Source

What's changed

This fixes a build failure with Swift version 5.10.

v1.4.0: Swift-DocC-Plugin 1.4.0

Compare Source

What's Changed
  • You can now customize the minimal access level of symbols to include in your documentation. The default access level continues to be "public" for libraries and "internal" for executables. To specify a custom minimal access level, pass the new --symbol-graph-minimum-access-level flag:
    swift package generate documentation
    --symbol-graph-minimum-access-level internal
    --target [target-name]

  • You can now generate a combined documentation archive with the documentation for multiple targets when building with Swift 6.0 or later. Each target's documentation can link to its target dependencies' documentation. This is an opt-in, experimental feature that can used by passing the --enable-experimental-combined-documentation flag:
    swift package generate documentation
    --enable-experimental-combined-documentation
    --target [first-target-name]
    --target [second-target-name] \

  • Using a custom --output-path when building documentation for more than one target no longer causes one target to write over the output of the other target. Instead, both targets write their output in subdirectories of the specified output path. When building documentation for a single target, or when building combined documentation, the plugin continues to write the output directly to the specified output path.

  • The help text in swift package generate-documentation --help now includes information about all the DocC options. The help text also organizes the symbol graph options into its own section.


The 1.4.0 release includes contributions from @​natikgadzhi, @​d-ronnqvist, @​JessyCatterwaul, @​joey-gm, @​dabrahams, @​parispittman, @​SwiftCoderJoe, and @​Kyle-Ye. Thank you!

v1.3.0: Swift-DocC-Plugin 1.3.0

Compare Source

What's Changed
  • Documentation for Swift symbols that extend other modules is now included by default when building with Swift 5.9 or later. To exclude external types when building Swift 5.9 or later, you can pass the new --exclude-extended-types flag:

    swift package generate-documentation --exclude-extended-types --target [target-name]

The 1.3.0 release includes contributions from @​theMomax. Thank you!

v1.2.0: Swift-DocC-Plugin 1.2.0

Compare Source

What's Changed
  • You can now generate documentation that includes Swift symbols that extend other modules when building with Swift 5.8 or later. This is an opt-in feature that can be used by passing the --include-extended-types flag:

    swift package generate-documentation --include-extended-types --target [target-name]
  • You can now generate documentation that excludes compiler synthesized symbols provided by default implementations of protocol requirements. This is an opt-in, experimental feature that can used by passing the --experimental-skip-synthesized-symbols flag:

    swift package generate-documentation --experimental-skip-synthesized-symbols --target [target-name]

The 1.2.0 release includes contributions from @​finestructure, @​sofiaromorales, and @​theMomax. Thank you!

v1.1.0

Compare Source


Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.


  • If you want to rebase/retry this PR, check this box

This PR was generated by Mend Renovate. View the repository job log.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants