realm / jazzy

Soulful docs for Swift & Objective-C
https://realm.io
MIT License
7.35k stars 413 forks source link

Runtime error when running Jazzy for unit tests target #604

Closed ksumman closed 8 years ago

ksumman commented 8 years ago

I'm trying to use Jazzy to generate documentation for a unit-tests target in my Xcode project. This target has only Objective-C files.

Here are a couple of commands I've tried:

jazzy --objc --clean --xcodebuild-arguments '-workspace,MyProject.xcworkspace,-target,UnitTests'
jazzy --objc --clean --xcodebuild-arguments '--objc,-workspace,MyProject.xcworkspace,-target,UnitTests'

Unfortunately these commands result in this runtime error:

Unrecognized arguments: -awrpcosek, -eagrt
/Library/Ruby/Gems/2.0.0/gems/jazzy-0.7.0/lib/jazzy/executable.rb:36:in `execute_command': /Library/Ruby/Gems/2.0.0/gems/jazzy-0.7.0/lib/jazzy/SourceKitten/bin/sourcekitten ["doc", "--objc", "-workspace", "MyProject.xcworkspace", "-target", "UnitTests"] (RuntimeError)

Unrecognized arguments: -awrpcosek, -eagrt
    from /Library/Ruby/Gems/2.0.0/gems/jazzy-0.7.0/lib/jazzy/sourcekitten.rb:147:in `run_sourcekitten'
    from /Library/Ruby/Gems/2.0.0/gems/jazzy-0.7.0/lib/jazzy/doc_builder.rb:64:in `block in build'
    from /Library/Ruby/Gems/2.0.0/gems/jazzy-0.7.0/lib/jazzy/doc_builder.rb:62:in `chdir'
    from /Library/Ruby/Gems/2.0.0/gems/jazzy-0.7.0/lib/jazzy/doc_builder.rb:62:in `build'
    from /Library/Ruby/Gems/2.0.0/gems/jazzy-0.7.0/bin/jazzy:15:in `<top (required)>'
    from /usr/local/bin/jazzy:23:in `load'
    from /usr/local/bin/jazzy:23:in `<main>'

Is anyone else running into a similar issue? Please let me know if I am using correct options in the command. Thanks in advance for your help.

jpsim commented 8 years ago

Xcode doesn't let you build unit test targets directly. See #504.