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

Cocoadocs aren't generated properly #1025

Closed
sxg opened this issue Jan 23, 2016 · 4 comments · Fixed by #1027
Closed

Cocoadocs aren't generated properly #1025

sxg opened this issue Jan 23, 2016 · 4 comments · Fixed by #1027
Assignees
Labels
Milestone

Comments

@sxg
Copy link

sxg commented Jan 23, 2016

If you go to Alamofire's Cocoadocs page, you'll see there's an error parsing the pod. I ran into the same problem with my project, ForecastIO. The issue is that there are two .xcodeproj files at the root of the repo ("Alamofire.xcodeproj" and "iOS Example.xcodeporoj"). In order for Cocoadocs to properly generate docs for Alamofire, "iOS Example.xcodeproj" needs to be moved out of the root.

@jshier
Copy link
Contributor

jshier commented Jan 24, 2016

Thanks for letting us know. We'll get this fixed ASAP.

@jshier jshier added the bug label Jan 24, 2016
@sxg
Copy link
Author

sxg commented Jan 25, 2016

It looks like Cocoadocs now supports .jazzy.yaml config files. Instead of moving the example project out of the root, you can add a jazzy config file that specifies which project should be used.

@richellis
Copy link

FWIW, CocoaDocs works for Alamofire version 3.1.3: http://cocoadocs.org/docsets/Alamofire/3.1.3/

@cnoon cnoon added this to the 3.2.0 milestone Feb 4, 2016
@cnoon
Copy link
Member

cnoon commented Feb 4, 2016

@jshier has already created one approach in #1027. I'm going to close this issue out for now. Please direct all future comments to #1027. 👍🏼

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.

4 participants