Godot-docs: Generate a docset for zeal/dash: offline doc readers

[akien-mga]

See https://zealdocs.org/ and https://kapeli.com/dash. The former is libre and inspired by the latter, and they share the same "docset" format. There are instructions on how to generate a docset from a sphinx project: https://kapeli.com/docsets#python

[haxpor]

How would you like this to go? I believe building such an offline doc is trivial. The point might be automatically build it every time new commit of doc pushed to repo, build offline docs, update links for users to download in case they need offline ones to browse. Is these what you thought about?

[Yanpas]

Here is what I've found in the internet, haven't tried btw.

I have experience in generating dash-docsets. I think this may be approached with a script with following algorithm:

1. clone this repo
2. for each file in classes directory generate html using pandoc
3. create an index of classes
4. (optionally, but almost mandatory) parse each generated html to find member functions, attributes etc stuff (rst format is pretty tough, maybe sphinx may be used as a library (research is needed))

[vnen]

@Yanpas the classes here are generated from the XML files in the main Godot repository (https://github.com/godotengine/godot/tree/master/doc/classes). I think it's easier to generate something from the XML than to parse RST or HTML.

[Yanpas]

That's good news. Seems to be much easier task

[Yanpas]

I've written the generator: https://github.com/Yanpas/godotdocset

I will improve it (add readme, css, sidemenu), but it already works

It's MIT, so godot project may grab it

[Yanpas]

I've improved the generator, I've also added precompiled docset Godot.docset.7z - you may try it.

[Calinou]

The documentation is also available on DevDocs which can work offline. It needs to be updated for Godot 3.2 though.

You can also download offline HTML builds from this page.