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

Support multiple modules/targets #1199

Closed
DanielCardonaRojas opened this issue Jun 1, 2020 · 4 comments
Closed

Support multiple modules/targets #1199

DanielCardonaRojas opened this issue Jun 1, 2020 · 4 comments
Labels

Comments

@DanielCardonaRojas
Copy link

Is there a way to document a project with more than one target ?

I passed multiple target arguments to xcodebuild_arguments and the generated documentation did not include docs from those targets.

@johnfairh
Copy link
Collaborator

You'll need to generate each module separately then merge - see #1194 for outline.

@DanielCardonaRojas
Copy link
Author

Thanks works great!

It would be nice if classes/structs/enums could include some information about the target they belonged to, as this information is lost on merge.

@johnfairh
Copy link
Collaborator

You're completely right; I should have explained this is an ad-hoc workaround -- Jazzy itself doesn't understand multiple modules per docset, which means that you can't tell what module a thing come from, cross-module extensions are not clear, and types that share names in separate modules get merged (or worse). #564 is the tracker for adding this as a full feature.

@1ec5
Copy link
Collaborator

1ec5 commented Jun 2, 2020

Depending on whether the modules have any interdependencies, you might be able to create a fake CocoaPods podspec for a combined module and run jazzy over that podspec instead of your normal project.

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

No branches or pull requests

3 participants