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

Doesn't generate proper docset without --module #921

Closed
hollanderbart opened this issue Dec 5, 2017 · 4 comments · Fixed by #1333
Closed

Doesn't generate proper docset without --module #921

hollanderbart opened this issue Dec 5, 2017 · 4 comments · Fixed by #1333
Labels

Comments

@hollanderbart
Copy link

With several internal projects I experience the issue where the docset simple isn't generated. The folders stays empty and I'm using the default build instruction. Can I get insight in some jazzy logging? xcodebuild runs fine and HTML looks fine also.

@johnfairh
Copy link
Collaborator

Try ls -a in the docs/docsets/ directory? The only gotcha I can see is that if you do not give jazzy --module then it uses an empty string for the docset name, accidentally creating hidden files.

I think we should skip docset creation + warn if the module name is not set: the name is used in various dash metadata as well as filenames so defaulting to 'Jazzy' or something doesn't feel right + won't point users towards what to fix. I doubt anyone is currently relying on the oddly named docsets.

@hollanderbart
Copy link
Author

hollanderbart commented Dec 6, 2017

Providing the --module or -m parameter solved it! Thanks!

@johnfairh
Copy link
Collaborator

I'm going to keep this open to do some code changes to avoid/warn about this.

@johnfairh johnfairh reopened this Dec 6, 2017
@johnfairh johnfairh changed the title Doesn't generate docset Doesn't generate docset without --module Dec 6, 2017
@johnfairh johnfairh added the bug label Dec 6, 2017
@johnfairh johnfairh changed the title Doesn't generate docset without --module Doesn't generate proper docset without --module Dec 6, 2017
@hollanderbart
Copy link
Author

Great to see that you're going to improve the experience! 👍

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

Successfully merging a pull request may close this issue.

2 participants