Show Dash user contrib docsets in Zeal

[jboadas]

Just trying to see the user contrib docsets but can't see it on the list

[sirajulm]

Which docset creates the problem? Have you checked with some other user contributed docsets?
Are the config files proper as specified here:
Generating Dash Docsets

[josephfinlayson]

You do it this way:

https://twitter.com/J4lf/status/553489605958594560

[wosc]

Thanks @josephfinlayson for pointing out that "feed" can also be a Tarball!

However, most Tarballs are removed from the User Contributions repository and uploaded to the @Kapeli CDN, which is not publicly accessible AFAICT, so what you need to do is trawl through the Pull Requests and look for the Tarballs there.

This is a bit of annoying manual work, but I don't know what a more convenient solution could look like, since I don't think it would be fair to ask @Kapeli to offer these docsets for us non-paying Zeal users via bandwidth/resources that @Kapeli is paying for.

[Kapeli]

Sorry for not seeing this issue earlier!

Actually I'd be glad if Zeal would use these docsets as well. I already allow access to the other (main) docsets, so I don't see a reason why not to do the same with the user contributed ones.

You can get a json of all the available user contributed docsets at http://sanfrancisco.kapeli.com/feeds/zzz/user_contributed/build/index.json

Once you have that, you can get to the docset archives like this:

http://<mirror>.kapeli.com/feeds/zzz/user_contributed/build/<key name inside json>/<archive name>

Examples:

http://newyork.kapeli.com/feeds/zzz/user_contributed/build/Atom/Atom.tgz
http://london.kapeli.com/feeds/zzz/user_contributed/build/SDL/org.libsdl.sdl20.docset.tgz

The icons in the json are base64 encoded.

Regarding the <mirror> part, you're supposed to choose the closest/best mirror. I've given details about how to do that to @trollixx.

[trollixx]

Thank you, @Kapeli!

I am working on a revamped docset manager for Zeal, which will include user contributed docsets.

[lowjoel]

Would RDoc/Yard documentation support (like Dash) belong to this ticket also?

[dkniffin]

👍 to rdoc support in zeal.

[NoAnyLove]

Since I was looking for docset for matplotlib, it's very happy to find this and finally soveld my problem. Thank you @Kapeli !

[lowjoel]

@Kapeli The instructions on the Dash site only show how to get docsets for published gems Yardoc/Rdoc, but doesn't document how to generate them. Any way to document that in the meanwhile?

[Kapeli]

Nope, sorry. The tool Dash uses to generate docs from Ruby Gems is not really usable if it's not run by Dash. I'll open-source it and package it into something everyone can use if more users ask.

The tool is written in Objective-C, so it won't be usable outside of OS X even if I release it.

[lowjoel]

@Kapeli I'm looking forward to it, if it's released. Even if it's in Obj-C I think people would write ports.

In the absence of that, does your docset license allow Zeal to use the Gem documentation from your site?

[Kapeli]

In the absence of that, does your docset license allow Zeal to use the Gem documentation from your site?

No idea what you mean. What gem documentation?

[lowjoel]

@Kapeli Dash allows users to download Yardoc/Rdoc documentation for gems, running through your generator on your end. Since your docsets are licensed out for Zeal, does that allow Zeal to request for Yardoc/Rdoc docsets through your service too?

(Maybe I'm missing something)

[Kapeli]

The Ruby Gem docsets are not generated on my servers. Dash (i.e. the client) downloads the Ruby Gem from rubygems.org, then generates the documentation using yard and then generates the docset. This all happens locally. My servers are not involved.

[lowjoel]

I see, so then for that we would need that tool to generate the proper docsets... Let's see what demand is like.

I was really looking forward to that since I'm doing Rails apps quite a lot nowadays...

[trollixx]

I've created #285 to track progress on Ruby documentation generation. This issue is about supporting user-contributed docsets from Dash.

[prusswan]

It would be "good to have"

[kidd]

Trying to implement the ability to get custom docsets, I find that by building the string as explained in this thread, I get things like "http://newyork.kapeli.com/feeds/zzz/user_contributed/build/Google App Engine - Python/GAE-Python.tgz" which have spaces, and they don't seem to exist. tried urlencoding and didn't work either... @Kapeli , any hints?

[trollixx]

It should be http://newyork.kapeli.com/feeds/zzz/user_contributed/build/Google_App_Engine-Python/GAE-Python.tgz.

[Kapeli]

You're supposed to add the "key" of the dictionary entry (first line in the sample below), not the value under name. That would be Google_App_Engine-Python instead of Google App Engine - Python.

    "Google_App_Engine-Python" : {     // <--- use this
      "author" : {
        "name" : "TZ Martin",
        "link" : "https:\/\/twitter.com\/tzmartin"
      },
      "aliases" : [
        "Google App Engine Python",
        "AppEngine",
        "Google Cloud"
      ],
      "archive" : "GAE-Python.tgz",
      "specific_versions" : [
        {
          "version" : "1.6.9.445",
          "archive" : "versions\/1.6.9.445\/GAE-Python.tgz"
        }
      ],
      "version" : "1.6.9.445",
      "name" : "Google App Engine - Python"
    },

[despairblue]

@Kapeli do the user contrib docs also have xml feeds?

At the moment if one wants to use one of the user contrib docs one has to download the archive and extract it manually into zeals docset folder, since zeal's add feed option only accepts xml feads not the tgz links directly.

[onorua]

In case you came here from web search. I've tried suggested by @Kapeli workaround, it downloads docset, but then fails with:
Invalid docset feed!.
e.g.
http://sanfrancisco.kapeli.com/feeds/zzz/user_contributed/build/Vault/Vault.tgz

But the following app: http://zealusercontributions.herokuapp.com/
is working fine.

[rixx]

But the following app: http://zealusercontributions.herokuapp.com/ is working fine.

It seems to be unavailable now. https://zealusercontributions.now.sh/ is a working mirror.

[filips123]

Is there any update? Is it possible to add support to download user contrib docsets directly from Zeal?

[jmerle]

To make it just a little easier to add the user contributed docsets to Zeal with the icons included I created zeal-user-contrib, which automates the steps you'd have to take when adding them manually via zealusercontributions.herokuapp.com.

It automatically detects Zeal's docsets directory, downloads the docset, extracts it, saves the icons and stores the necessary metadata in the correct location. I have tested it on both Linux and Windows, and it will also find the docsets directory when you've set the it to a custom path in the settings.

[hashhar]

I coincidentally saw this issue today and thought somebody might find https://github.com/hashhar/dash-contrib-docset-feeds repo I created a long time ago useful.

It is automated to be updated once every 7 days. It doesn't download the files, just creates an index in the repo itself.

[crmne]

Hi everyone, while we wait for 0.8.0 to have this feature, I made a script that has a simple UI to download and install user contrib docsets: https://gist.github.com/crmne/3fe84c05013fa87d74a8

[Mek101]

Will they be implemented?

[OuttaSpaceTime]

@Kapeli any updates on the ruby gems by now? Would be nice if you could open source it. Has been a while now :)

I found this script but I am not sure on how to use https://gist.github.com/toch/77ce4210e962cb73782d003a89f17dcd