Failing but the reason is not clear.

[rodriguise]

Failed to generate documentation

/Library/Ruby/Gems/2.0.0/gems/jazzy-0.1.0/lib/jazzy/sourcekitten.rb:51:in `run_sourcekitten': Running `/Library/Ruby/Gems/2.0.0/gems/jazzy-0.1.0/lib/jazzy/sourcekitten/sourcekitten doc` failed:  (RuntimeError)
    from /Library/Ruby/Gems/2.0.0/gems/jazzy-0.1.0/lib/jazzy/doc_builder.rb:55:in `build'
    from /Library/Ruby/Gems/2.0.0/gems/jazzy-0.1.0/bin/jazzy:15:in `<top (required)>'
    from /usr/bin/jazzy:23:in `load'
    from /usr/bin/jazzy:23:in `<main>'

[segiddins]

This is a known issue with sourcekitten.

[Simulacrotron]

@segiddins is there any workaround

[Bierrot]

Same here, only for objective-c project

[segiddins]

This should be fixed in Jazzy 0.1.2?

[jpsim]

I'm unsure what this issue is, so I can't say if it will be fixed in the next version of jazzy. If you can run sourcekitten on your project and post the output here, I'll be able to help troubleshoot.

[jpsim]

@rodriguise @Simulacrotron @Bierrot could you check to see if this issue still happens with the latest version of jazzy (0.2.0)? If it does, please share steps to reproduce. Thanks!

[nicolas-miari]

I get a similar error log (Xcode 7 Beta 5, Swift 2):

fatal error: unexpectedly found nil while unwrapping an Optional value
    from /Library/Ruby/Gems/2.0.0/gems/jazzy-0.2.4/lib/jazzy/sourcekitten.rb:71:in `run_sourcekitten'
    from /Library/Ruby/Gems/2.0.0/gems/jazzy-0.2.4/lib/jazzy/doc_builder.rb:53:in `block in build'
    from /Library/Ruby/Gems/2.0.0/gems/jazzy-0.2.4/lib/jazzy/doc_builder.rb:51:in `chdir'
    from /Library/Ruby/Gems/2.0.0/gems/jazzy-0.2.4/lib/jazzy/doc_builder.rb:51:in `build'
    from /Library/Ruby/Gems/2.0.0/gems/jazzy-0.2.4/bin/jazzy:15:in `<top (required)>'
    from /usr/bin/jazzy:23:in `load'
    from /usr/bin/jazzy:23:in `<main>'

...is it the same issue?

[jpsim]

@nicolas-miari the version of jazzy you're using only targets Swift 1.2. For Swift 2.0 support (only with Xcode 7 Beta 6), please use the swift-2.0 branch (#261).

[nicolas-miari]

Great, thanks! Sorry I missed that.

[nicolas-miari]

@jpsim I had some issues building json -v 1.8.3 during the bundle install part, but after installing the xcode command line tools (as suggested somewhere), it worked! All my project's classes and extensions are documented (--min-acl internal)

Because of the wording of Jazzy's README.md page, I was afraid I also would have to build sourcekitten from source, but that doesn't seem to be the case.

[nicolas-miari]

...aaaand, the same command fails when I paste it to Xcode's RunScript phase (so that my docs update everytime I build the target):

/Users/(my_username)/Projects/Jazzy/jazzy.gemspec:17: warning: Insecure world writable dir /usr in PATH, mode 040777
/Users/(my_username)/Projects/Jazzy/lib/jazzy/sourcekitten.rb:72:in `run_sourcekitten': undefined method     `as_env' for nil:NilClass (NoMethodError)
        from /Users/(my_username)/Projects/Jazzy/lib/jazzy/doc_builder.rb:53:in `block in build'
    from /Users/(my_username)/Projects/Jazzy/lib/jazzy/doc_builder.rb:51:in `chdir'
    from /Users/(my_username)/Projects/Jazzy/lib/jazzy/doc_builder.rb:51:in `build'
    from /Users/(my_username)/Projects/Jazzy/bin/jazzy:15:in `<main>'
Command /bin/sh failed with exit code 1

(side note: yes, I built the gem into ~/Projects/Jazzy/bin/ and haven't played with the PATH yet... Not sure what's the best course of action; but for now I run jazzy with the full path to the executable)

Any tips on what could be happening?

[jpsim]

@nicolas-miari in your case, jazzy is failing because it can't find an Xcode version for the version of Swift you've requested (or 1.2 by default). Could you please open a new issue so we can troubleshoot?

[nicolas-miari]

Weird... I did run xcode-select to point to the (laterst) beta. Will open issue now, thanks!