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

Show Dash user contrib docsets in Zeal #170

Open
jboadas opened this Issue Jun 30, 2014 · 51 comments

Comments

@jboadas
Copy link

jboadas commented Jun 30, 2014

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

@sirajulm

This comment has been minimized.

Copy link

sirajulm commented Jul 10, 2014

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

This comment has been minimized.

Copy link

josephfinlayson commented Jan 9, 2015

@trollixx trollixx changed the title Can I see Dash user contrib Docset in Zeal ? Show Dash user contrib docsets in Zeal Jan 22, 2015

@trollixx trollixx assigned trollixx and unassigned trollixx Jan 22, 2015

@wosc

This comment has been minimized.

Copy link

wosc commented Jan 24, 2015

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

This comment has been minimized.

Copy link
Contributor

Kapeli commented Jan 24, 2015

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

This comment has been minimized.

Copy link
Member

trollixx commented Jan 25, 2015

Thank you, @Kapeli!

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

@lowjoel

This comment has been minimized.

Copy link
Contributor

lowjoel commented Jan 25, 2015

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

@dkniffin

This comment has been minimized.

Copy link

dkniffin commented Feb 12, 2015

👍 to rdoc support in zeal.

@NoAnyLove

This comment has been minimized.

Copy link

NoAnyLove commented Feb 13, 2015

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

@lowjoel

This comment has been minimized.

Copy link
Contributor

lowjoel commented Mar 4, 2015

@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

This comment has been minimized.

Copy link
Contributor

Kapeli commented Mar 4, 2015

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

This comment has been minimized.

Copy link
Contributor

lowjoel commented Mar 4, 2015

@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

This comment has been minimized.

Copy link
Contributor

Kapeli commented Mar 4, 2015

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

This comment has been minimized.

Copy link
Contributor

lowjoel commented Mar 4, 2015

@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

This comment has been minimized.

Copy link
Contributor

Kapeli commented Mar 4, 2015

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

This comment has been minimized.

Copy link
Contributor

lowjoel commented Mar 4, 2015

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

This comment has been minimized.

Copy link
Member

trollixx commented Mar 5, 2015

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

@prusswan

This comment has been minimized.

Copy link

prusswan commented Mar 26, 2015

It would be "good to have"

@trollixx trollixx added this to the 0.2.0 milestone Mar 26, 2015

@kidd

This comment has been minimized.

Copy link

kidd commented Apr 10, 2015

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

This comment has been minimized.

@Kapeli

This comment has been minimized.

Copy link
Contributor

Kapeli commented Apr 10, 2015

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

This comment has been minimized.

Copy link

despairblue commented Apr 29, 2015

@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.

@sciunto

This comment has been minimized.

Copy link

sciunto commented Jun 28, 2016

A quick comment. Dash can't fix wrong naming (and they obviously don't want to fix the bug). It results that at least one xml file has a wrong name in https://github.com/zsoltika/feeds

See Kapeli/Dash-User-Contributions#984

@thuandt

This comment has been minimized.

Copy link

thuandt commented Sep 23, 2016

Does Zeal 0.3.0 support Dash Contrib Docsets?

I saw github tag but seem src code still isn't push to launchpad (PPA)

@trollixx

This comment has been minimized.

Copy link
Member

trollixx commented Sep 23, 2016

@sntiagoma

This comment has been minimized.

Copy link

sntiagoma commented Jan 2, 2017

This may help someone,
Based on https://kapeli.com/feeds/zzz/user_contributed/build/index.json

I've created this tool to get feed URLs to add to Zeal http://zealusercontributions.herokuapp.com/
For example, with Emacs the feed URL is http://zealusercontributions.herokuapp.com/docsets/Emacs.xml
Also in Home page you can get the icons to download them into the docset folder and all avaliable docsets and its URLs.

If someone wants to create its own page or use as a base the code is public: https://github.com/sntiagoma/zealusercontributions

Mirror: http://zealusercontributions.now.sh/

@trollixx

This comment has been minimized.

Copy link
Member

trollixx commented Jan 2, 2017

@sntiagoma this is a pretty cool workaround for my laziness :) Thanks for sharing!

@marcopompili

This comment has been minimized.

Copy link

marcopompili commented Apr 4, 2017

I got a problem with the ClojureScript docset, I don't know why but it's the only docset that doesn't work. None of the links work, if I click on a function name in the search results, zeal will not display the contents.

Permissions seem fine, the html files are weirdly generated like: write-all-eb3cea2d014abb6fa8d88309f08e3e08.html

I tried to change some files to something like: write-all.html but without success. There's some way to debug this problem ? Thank you

p.s. I tried to use the same docset on helm-dash and I got no problem there.

SOLVED: I found the problem, in the docSet.dsidx file the path column was starting with: /

like: /news/0.0-927.html Changing the path from absolute to relative like this: news/0.0-927.html fixed the problem, I used this query on sqliteman for fixing the whole table:

UPDATE searchIndex set path = substr(path,2)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment