The Coq mailing list

[Tony Sloane <inkytonik AT gmail.com>]

Hi Harley,

On 05/03/2013, at 3:32 AM, "Harley D. Eades III" 
<harley.eades AT gmail.com>
 wrote:

>> Hi everyone,
>> 
>> Mac users may know of the Dash documentation browser (http://kapeli.com). 
>> It's a nice way to have a consistent, easily searchable collection of 
>> documentation.
>> 
>> I've put together a Dash docset for Coq 8.4 that you can find on our 
>> resources page:
>> 
>>   https://wiki.mq.edu.au/display/plrg/Resources
>> 
>> The docset includes the reference manual and the standard library 
>> documentation, plus the indexes of both. 
>> 
>> If you try it, I think you'll find that Dash and this docset makes it very 
>> easy to find things in this documentation.
> This is great!  Nice work.

Thanks. Glad you like it.

> How did you go about creating the docset?

I have some custom scripts that process the refman and stdlib HTML. 
Unfortunately, not all of this process is automatic for the Coq documentation 
because some of the HTML is not easy to read automatically.

> Are there HTML to docset converters?

You can find docs on how to produce Dash docsets from various sources here:

    http://kapeli.com/docsets/

In practice the trickiest issue is generating the index information. In the 
case of the Coq docset, I basically use the index files that are already 
present in that documentation. The Dash documentation describes the format of 
the docsets and the sqlite database that you have to generate.

I haven't published the code to generate the Coq docset anywhere yet, but a 
similar project I did to convert Scala documentation into a docset can be 
found here: 

    https://bitbucket.org/inkytonik/mkscaladocset/overview.

regards,
Tony

P.S. I'm happy to help if you try to generate a docset for something else, 
but we should take it off coq club since the topic is not relevant there.