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

Add support for custom docc "build" flags #2303

Closed
finestructure opened this issue Mar 21, 2023 · 5 comments
Closed

Add support for custom docc "build" flags #2303

finestructure opened this issue Mar 21, 2023 · 5 comments

Comments

@finestructure
Copy link
Member

As discussed in the Documentation WG, in order to give authors some control over docc feature opt-in we want to support a way to let them specify custom flags that are passed on to swift package generate-documentation.

@finestructure
Copy link
Member Author

We are currently supporting two different modes when building docs: via spm (macOS and Linux docs) and via xcodebuild (ios docs).

Via spm we run (essentially)

  • swift package generate-documentation --target <target>

whereas xcodebuild does

  • xcodebuild docbuild -scheme <target>
  • xcodebuild docc process-archive transform-for-static-hosting

Which command needs the support for custom flags in case of ios doc builds? I'm hoping we can just have on entry that supports both doc build use cases.

@finestructure
Copy link
Member Author

I'll assume it's the docc command for now, so a custom build command would go to

  • swift package generate-documentation --target <target> $custom

or

  • xcodebuild docc process-archive transform-for-static-hosting $custom

depending which platform the author has chosen.

@finestructure
Copy link
Member Author

finestructure commented Mar 24, 2023

@finestructure
Copy link
Member Author

Ok, needs to be passed to docbuild via OTHER_DOCC_FLAGS:

% xcodebuild docbuild OTHER_DOCC_FLAGS='--diagnostic-level error --experimental-parse-doxygen-commands'

https://swift-open-source.slack.com/archives/C04PCMXMBD0/p1679675776691159?thread_ts=1679643396.399739&cid=C04PCMXMBD0

@finestructure
Copy link
Member Author

finestructure commented Mar 29, 2023

This is live since Monday via builder 4.15.0

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