GNOME Bugzilla – Bug 723533
[patch] docset bundles support
Last modified: 2017-12-10 11:14:46 UTC
Created attachment 267949 [details] [review] The patch produced by the git-format-patch There are also related bug on the launchpad: https://bugs.launchpad.net/ubuntu/+source/devhelp/+bug/1242467 and a pull request on the GitHub: https://github.com/GNOME/devhelp/pull/2 Please find the patch attached (the patch was created with git fomat-patch). The optional docset support depends on docset library (https://github.com/roman-kashitsyn/libdocset) which is not uploaded to any package repository yet. I appreciate any help in making it public.
Excuse my ignorance but what are docset bundles? How would they get installed on the system?
Docset bundle is relatively popular documentation format. They are used by Dash application (http://kapeli.com/dash), XCode and some other applications (http://zealdocs.org). There are lot of freely available documentation bundles on the Kapeli web site: http://kapeli.com/docset_links In addition, Doxygen can generate docset bundles. Under the hood it's just a directory containing a bunch of html documents, xml-file with metadata, and an sqlite tag database. You can find more details here: http://kapeli.com/docsets
(In reply to comment #1) > Excuse my ignorance but what are docset bundles? How would they get installed > on the system? See also this thread for more context: https://mail.gnome.org/archives/gnome-devtools/2014-February/msg00000.html
I've created a PPA on launchpad: ppa:romankashicin/docset-utils the libdocset0-dev package providing the libdocset library could be installed from the PPA. Only Ubuntu 13.10 release is supported at the moment.
I think it's better for the Devhelp code to keep things simple and to support only one format: a *.devhelp2 index file with a bunch of HTML files. So the best way to support "docset bundles" is to generate a *.devhelp2 index file, assuming that the documentation is available in HTML.