Skip to content

[GLOBAL] Fix make-docc-documentation.sh for multi cmd packages #46

@Blackjacx

Description

@Blackjacx

ToDo


  • ASCKit/
  • Assist/
  • Columbus/
  • Engine/
  • Quickie/
  • SHDateFormatter/
  • SHSearchBar/
  • Source/

The script currently cannot deal with:

  • multi command packages: The package specifier (e.g. Assist) is used to build the package. It has to be checked using (xcodebuild -list -json) which are the targets and if there is a <target-name>-Package which can build the documentation for them all
  • packages for macOS targets: The destination is hardcoded inside the script for iOS it should be passed and handled correctly in the release script

An exmple would be to integrate the official DocC PLugin with SPM:

    dependencies: [
		[...]
        .package(url: "https://github.com/apple/swift-docc-plugin", from: "1.0.0")
		[...]
    ],

swift package plugin --list

# ‘generate-documentation’ (plugin ‘Swift-DocC’ in package ‘SwiftDocCPlugin’)
# ‘preview-documentation’ (plugin ‘Swift-DocC Preview’ in package ‘SwiftDocCPlugin’)

swift package preview-documentation 
# Note: The Swift-DocC Preview plugin requires passing the '--disable-sandbox' flag
swift package --disable-sandbox preview-documentation

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions