I’ve mentioned this as a response to an old thread here on the forum, but I thought it might be worthwhile to mention this in a post of its own. Dash is a handy little API reference tool and I use it quite frequently in my day to day work when I need to look up API functions.
UPDATE:
Dash has now been added as a User Contribution to the list of docsets available from Downloads → User Contributions.
The advantage of installing the docset this way is that the documentation will automatically update when we (I) publish new versions. I will also try to get the docset available from the official list of docsets.
I created a python script to parse the intermediate format we use when we generate the API reference on the Defold site to also output a Dash docset for Defold. If you happen to use Dash you can find the docset in this GitHub repo.
The advantage of installing the docset this way is that the documentation will automatically update when we (I) publish new versions. I will also try to get the docset available from the official list of docsets.
Yes, that is probably doable. The raw data for the documentation is available to download from our site, just like the engine, editor and everything else. It’s in the ref-doc.zip file, http://d.defold.com/archive//engine/share/ref-doc.zip, where sha1 matches the release (for the current stable you can find it from d.defold.com/stable/info.json).
A snippet file generated from the api docs for using in Atom editor.
For windows version of editor open File->Snippets and copy/paste text from the attached file to the opened one.
Ready for feedback. (:
Nice! It seems to be working well! You should put the script up on GitHub and add some instructions for those who are not familiar with Atom snippets. And make a separate post of it here on the forum as well.
For those who have Visual Studio Code I converted snippets to that format. Just open Code → Preferences → User snippets → select lua → copy from archive and paste there → save. Works well. lua.json.zip (14.8 KB)
