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

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

Open
2 of 8 tasks
Blackjacx opened this issue Sep 2, 2022 · 0 comments
Open
2 of 8 tasks

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

Blackjacx opened this issue Sep 2, 2022 · 0 comments

Comments

@Blackjacx
Copy link
Owner

Blackjacx commented Sep 2, 2022

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
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

No branches or pull requests

1 participant