Defold docset for Dash

The Defoldmine
#1

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.

Screen Shot 2016-08-18 at 13.05.16.png706×576 71 KB

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.

6 Likes
API Reference down? (SOLVED)
Defold is consuming a lot of data plan
We are hosting a Web Monetization game jam
#2

Docset updated to Defold 1.2.85

2 Likes
#3

Big thanks. Really nice app. Will start using this one (not only for Defold)

1 Like
#4

Zeal is the Windows / Linux alternative to Dash, and works with the same format https://zealdocs.org/

1 Like
#5

Really thx @britzl i use Zeal on windows and it’s a perfect things Really Really man :slight_smile:

1 Like
#6

Docset updated to Defold 1.2.86

3 Likes
#7

Dash has now been added as a User Contribution to the list of docsets available from Downloads -> User Contributions.

Screen Shot 2016-08-18 at 13.05.16.png706×576 71 KB

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.

7 Likes
#8

Exellent in that way it will be avaiable with Zeal too :wink:

https://zealdocs.org/

1 Like
#9

@britzl
How do you think, maybe it’s possible to make Atom snippets using same way as you generated docs?

2 Likes
#10

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

1 Like
#11

snippets.cson.script (128.6 KB)

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. (:

6 Likes
Defold Editor 2.0
#12

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.

2 Likes
#13

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)

edit: made an archive fix…

5 Likes
#14

Docset updated to Defold 1.2.88

7 Likes
#15

thx for your work and all that you share

3 Likes
#16

Docset updated to Defold 1.2.89

2 Likes
#17

Docset updated to Defold 1.2.90

2 Likes
#18

Hi everyone, sorry if I’m being thick but what is the URL feed when using Zeal?
I’d really like to stop creating manually each docset at release.

Thanks!

#19

Answering my own question,

Zeal is yet to be capable of accessing directly contrib.kapeli.com : zeal issue

There is hope though and in the meantime you can pull the latest docset from the server manually:
http://london.kapeli.com/feeds/zzz/user_contributed/build/Defold/Defold.tgz

and install it as usual.

3 Likes
#20

Docset updated for 1.2.93.

2 Likes