realm / jazzy Goto Github PK

Cocoadocs does this and it looks great.

Redcarpet has :autolink: support, so it's just a matter of turning it on.

I'm trying to use Jazzy with the project, which uses CoreBluetooth Framework.
And Jazzy unable to find CoreBluetooth/CoreBluetooth file.
The command:

➜  CHCoreBluetooth git:(periodical_discovering) ✗ jazzy -i CHCoreBluetooth/ -o jazzydoc/
/Users/dals/Playground/ObjectiveC/CHFoundation/CHCoreBluetooth/CHCoreBluetooth/CBCharacteristic+CHCoreBluetooth.h:9:9: fatal error: 'CoreBluetooth/CoreBluetooth.h' file not found
/Library/Ruby/Gems/2.0.0/gems/jazzy-0.0.3/lib/jazzy.rb:36:in `document': undefined method `xpath' for nil:NilClass (NoMethodError)
    from /Library/Ruby/Gems/2.0.0/gems/jazzy-0.0.3/bin/jazzy:44:in `block in <top (required)>'
    from /Library/Ruby/Gems/2.0.0/gems/jazzy-0.0.3/bin/jazzy:43:in `each'
    from /Library/Ruby/Gems/2.0.0/gems/jazzy-0.0.3/bin/jazzy:43:in `<top (required)>'
    from /usr/bin/jazzy:23:in `load'
    from /usr/bin/jazzy:23:in `<main>'

Affected Category's Header:

#import <CoreBluetooth/CoreBluetooth.h>

@interface CBCharacteristic (CHCoreBluetooth)
- (BOOL)writable;
- (BOOL)readable;
- (BOOL)notificable;
- (NSString*)description;
@end

Thanks.

For example, Request.html exists here, but you can only navigate to it by directly clicking in the nav on the left side. A link should be included in the description:

Footer was removed because it was not displayed at the bottom of the page, but rather overlaid on top of other site content.

Hi

After installed jazzy, it tell me this error

xcrun: error: unable to find utility "sourcekitd-test", not a developer tool or in PATH
/Library/Ruby/Gems/2.0.0/gems/jazzy-0.0.4/lib/jazzy.rb:19:in +': no implicit conversion of nil into String (TypeError) from /Library/Ruby/Gems/2.0.0/gems/jazzy-0.0.4/lib/jazzy.rb:19:indocument'
from /Library/Ruby/Gems/2.0.0/gems/jazzy-0.0.4/bin/jazzy:44:in block in <top (required)>' from /Library/Ruby/Gems/2.0.0/gems/jazzy-0.0.4/bin/jazzy:43:ineach'
from /Library/Ruby/Gems/2.0.0/gems/jazzy-0.0.4/bin/jazzy:43:in <top (required)>' from /usr/bin/jazzy:23:inload'
from /usr/bin/jazzy:23:in `

I'm on Xcode 6 Beta 6.

Any fixing solution ?
Your project seems so good..

After running

gem install jazzy

and running jazzy in the terminal, I ran into the following error:

xcrun: error: unable to find utility "sourcekitd-test", not a developer tool or in PATH

I did some digging on SourceKit and found that the sourcekitd file in the Xcode developer path's sourcekit framework was a binary file and didn't say anything about sourcekitd-test.

Is this an issue with the Xcode 6 betas? I'm using Xcode 6 beta 5.

For SourceKit info check out http://www.jpsim.com/uncovering-sourcekit/

On a side note I'm also hitting the can't convert nil into String error but I don't think that's interfering with anything regarding xcrun and there's already an issue listed for this error.

Objective-C projects are no longer supported since v0.0.5.

When run as swift -emit-module foo.swift, swift produces 2 files:

• foo.swiftmodule
• foo.swiftdoc

The swiftdoc file is a binary file that picks up /// and /** style doc comments, but not Qt-style /*! comments.

Examining the headers for the Swift stdlib, it appears the input syntax is reST, as pointed out by @jspahrsummers here.

Go through, stating everything needed to get a development environment up & running, I know bunch of people are interested, but like with CocoaPods, they have no idea how to actually get a ruby dev env and a usable binary for testing with,

I'm getting this error both when trying to run Jazzy against a directory, and when simply getting jazzy usage:

jazzy -h                    
Usage: jazzy [-i input] [-o output]

Options
    -i, --input FOLDER               Folder to recursively search for header files
    -o, --output FOLDER              Folder to output the HTML docs to
    -e filepath1,filepath2,…filepathN,
        --exclude                    Exclude specific files
    -h, --help                       help
error response (Request Failed): Error occurred
/Library/Ruby/Gems/2.0.0/gems/jazzy-0.0.4/lib/jazzy.rb:19:in `+': no implicit conversion of nil into String (TypeError)
    from /Library/Ruby/Gems/2.0.0/gems/jazzy-0.0.4/lib/jazzy.rb:19:in `document'
    from /Library/Ruby/Gems/2.0.0/gems/jazzy-0.0.4/bin/jazzy:44:in `block in <top (required)>'
    from /Library/Ruby/Gems/2.0.0/gems/jazzy-0.0.4/bin/jazzy:43:in `each'
    from /Library/Ruby/Gems/2.0.0/gems/jazzy-0.0.4/bin/jazzy:43:in `<top (required)>'
    from /usr/bin/jazzy:23:in `load'
    from /usr/bin/jazzy:23:in `<main>'

I opened this ticket as I feel it's separate to the (similar, but already closed) #35. I'm using Jazzy 0.0.4, and Xcode6-beta2.

Wanted to try out jazzy on my Objective-C project with xcode 6 but I get the following output.

$ jazzy
/Library/Ruby/Gems/2.0.0/gems/jazzy-0.0.3/bin/SwiftHeader: line 16: /Applications/Xcode6-Beta.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/sourcekitd-test: No such file or directory
/Library/Ruby/Gems/2.0.0/gems/jazzy-0.0.3/lib/jazzy.rb:18:in `+': no implicit conversion of nil into String (TypeError)
    from /Library/Ruby/Gems/2.0.0/gems/jazzy-0.0.3/lib/jazzy.rb:18:in `document'
    from /Library/Ruby/Gems/2.0.0/gems/jazzy-0.0.3/bin/jazzy:44:in `block in <top (required)>'
    from /Library/Ruby/Gems/2.0.0/gems/jazzy-0.0.3/bin/jazzy:43:in `each'
    from /Library/Ruby/Gems/2.0.0/gems/jazzy-0.0.3/bin/jazzy:43:in `<top (required)>'
    from /usr/bin/jazzy:23:in `load'
    from /usr/bin/jazzy:23:in `<main>'

There are currently several references to CloudKit and other Apple-specific documentation that we should remove.

Hi! I'm a little lost on how to use it. I installed jazzy successfully. Now I have created a sample project in Xcode 6 beta 4 using Swift. And I have defined the comments like this.

/**
    Log in to the server.

    @param  username             Username entered by the user.
    @param  password             Password entered by the user.

    @return (UserID, Token)      ID of the logged with User & an API token.
    */
    public class func login(username: String, password: String) -> (Int, String) {

        return (1, "")
    }

Then from the Terminal, I navigated in to the project folder, ran jazzy jazzy -o ~/Desktop/Sample/. Three folders get created inside the Sample folder, CSS, JavaScript and Images. But no HTML file.

Am I doing this right? Or does Jazzy only supports comments in Objective-C?

I downloaded Jazzy today and got weird results - IE: no HTML. Some googling seems that it only supported beta2. Any ideas how to use with the release version of Xcode 6?

thanks!

Attempting to run jazzy -h after installing it via sudo gem install jazzy results in jazzy locking up for multiple seconds, at least. I have not allowed jazzy to execute for longer for fear of what it might be doing, but here's my interrupt dump:

^C/System/Library/Frameworks/Ruby.framework/Versions/2.0/usr/lib/ruby/2.0.0/find.rb:59:in `block (2 levels) in find': Interrupt
    from /System/Library/Frameworks/Ruby.framework/Versions/2.0/usr/lib/ruby/2.0.0/find.rb:56:in `reverse_each'
    from /System/Library/Frameworks/Ruby.framework/Versions/2.0/usr/lib/ruby/2.0.0/find.rb:56:in `block in find'
    from /System/Library/Frameworks/Ruby.framework/Versions/2.0/usr/lib/ruby/2.0.0/find.rb:42:in `catch'
    from /System/Library/Frameworks/Ruby.framework/Versions/2.0/usr/lib/ruby/2.0.0/find.rb:42:in `find'
    from /Library/Ruby/Gems/2.0.0/gems/jazzy-0.0.4/lib/jazzy.rb:5:in `headers'
    from /Library/Ruby/Gems/2.0.0/gems/jazzy-0.0.4/bin/jazzy:39:in `<top (required)>'
    from /usr/bin/jazzy:23:in `load'
    from /usr/bin/jazzy:23:in `<main>'

It seems that the CSS and JS assets are directly extracted from Apple's new documentation pages.

While this works quite well to get started quickly, it may become rapidly a nightmare to maintain (see #29 for example: I though I'd give it a look, but trying to fix a bug hidden in 1.2k lines of obfuscated JS in not particularly fun...).

Is there any plan to re-code the CSS and JS from scratch?

🐦🐤🐣

I understand this is an OSS project thus more then likely not getting your top priority... I would suggest taking this to indiegogo for funding so that it can be. I know for myself (and I am sure others: https://twitter.com/steipete/status/514652887767863296) would have no issue at all laying down a few hundred or even a grand or 2 to help see this project to a speedy release.

Ran jazzy -o ~/Desktop/ and it deleted all my files on ~/Desktop.

Currently, many values have to be passed in to jazzy manually that could be automated. For example:

• author_name
• module_name
• github_url
• github_file_prefix
• author_url

Unfortunately, the approach we took with Xcode 6 Betas 1 & 2 no longer work with Beta 3.

This still works:

$ xcrun sourcekitd-test -req doc-info SwiftFile.swift

but this no longer works:

$ xcrun sourcekitd-test -req doc-info -module MyModule -- -I `pwd` -sdk `xcrun --show-sdk-path`
sourcekit: [1:connection-event-handler:271: 0.0000] Connection interrupt
sourcekit: [1:pingService:271: 0.0016] pinging service
error response (Connection Interrupted): Connection interrupted

Seems to be an issue with sourcekitd-test's XPC connection with SourceKitService, but I'm unsure how to fix it. If anyone has any ideas, I'd ❤️ to hear from you!

Hosting some sample generated HTML documentation online will help convey what this project does.

repository: https://github.com/MailCore/mailcore2

~/.../mailcore2/src$ jazzy -i . -o jazzydoc
/Users/hoa/MailCore/mailcore2/src/MailCore/MCAbstract.h:5:10: fatal error: 'MailCore/MCAbstractMessage.h' file not found
/Library/Ruby/Gems/2.0.0/gems/jazzy-0.0.3/lib/jazzy.rb:36:in `document': undefined method `xpath' for nil:NilClass (NoMethodError)
    from /Library/Ruby/Gems/2.0.0/gems/jazzy-0.0.3/bin/jazzy:44:in `block in <top (required)>'
    from /Library/Ruby/Gems/2.0.0/gems/jazzy-0.0.3/bin/jazzy:43:in `each'
    from /Library/Ruby/Gems/2.0.0/gems/jazzy-0.0.3/bin/jazzy:43:in `<top (required)>'
    from /usr/bin/jazzy:23:in `load'
    from /usr/bin/jazzy:23:in `<main>'

Lots of headers in MailCore are included using for example <MailCore/MCAbstractMessage.h>

Is there anything I'm missing?