Nim: Create a docset for dash/zeal

[schlamar]

Having a docset for dash / zeal would be really great. The build steps should be straightforward, basically it's just writing the index to a SQLite database: http://kapeli.com/docsets

[gradha]

You can grab a dash version from http://forum.nimrod-lang.org/t/330. Didn't know about zeal, might look into generating it for that too.

[schlamar]

It's the same format :) Maybe you want to contribute it to the official channel of dash: https://github.com/Kapeli/Dash-User-Contributions#contribute-a-new-docset

[gradha]

Or contribute koch patches to build docsets, so the build farm could host the development docs feed.

[gitfoxi]

+1

Ideally, you want a general tool to import structured documentation into Dash. The structure should be shared across libraries which allows you to add commonly-used libraries to your docset and update as time goes on.

I'm not sure what the standard is in Nim but there must be one because pages like http://nim-lang.org/docs/theindex.html can be generated.

[gitfoxi]

Here is maybe the best starting point for such a project:

http://gradha.github.io/gh_nimrod_doc_pages/

[girvo]

:+1:

[SaitoWu]

:+1:

[wicast]

I have created a dashing.json file for dashing that can generate docset form any nim doc generated html.
Check it out.
https://github.com/wicast/nim-docset
There is also a prebuilded official document docset maintain by me.Tested with linux zeal.

[gitfoxi]

Cool. Thanks.
On Jan 26, 2016 9:36 PM, "wicast" [email protected] wrote:

I have created a dashing.json file for dashing
https://github.com/technosophos/dashing that can generate docset form
any nim doc html.
Check it out.
https://github.com/wicast/nim-docset
There is also a prebuilded official document docset maintain by me.

—
Reply to this email directly or view it on GitHub
https://github.com/nim-lang/Nim/issues/1401#issuecomment-175411083.

[Kentoseth]

Will Nim be added to the Dash/Zeal docset?

I have installed @wicast docs from his pre-build here: https://github.com/wicast/nim-docset/releases/download/v0.0.2/nim.docset.tar.7z

but that documentation is for 0.14.2 and Nim is now on 0.16.x

Is there a way to auto-build the docset for Dash/Zeal (and maintain separate versions for each docset edition) ?

[gitfoxi]

This may help: https://github.com/technosophos/dashing

I haven't tried it with nim but it does a good job with piles of HTML docs
so I'll bet it works if someone wants to put in 20-minute effort to develop
the dashing.json.

On Fri, Feb 17, 2017 at 1:20 AM, Moe [e-mail] wrote:

Will Nim be added to the Dash/Zeal docset?

I have installed @wicast https://github.com/wicast docs from his
pre-build here: https://github.com/wicast/nim-
docset/releases/download/v0.0.2/nim.docset.tar.7z

but that documentation is for 0.14.2 and Nim is now on 0.16.x

Is there a way to auto-build the docset for Dash/Zeal (and maintain
separate versions for each docset edition) ?

—
You are receiving this because you commented.
Reply to this email directly, view it on GitHub
https://github.com/nim-lang/Nim/issues/1401#issuecomment-280598646, or mute
the thread
https://github.com/notifications/unsubscribe-auth/AAjpRUMk5ui3pNnhOZhCe1zn6KmoEp67ks5rdWZigaJpZM4CQBah
.

--

-
Michael

[Araq]

So create PRs or let it be. Closing.

[rosshadden]

I just found this thing called DevDocs, which has Nim docs on it. For 0.18.0, even. It seems to be like Zeal/Dash, but through the browser (though it does support offline viewing, in a way...).

[genotrance]

FYI: https://forum.nim-lang.org/t/5050

I would like to store the generating script and data files in the Nim repo. I would also like to update the wiki to document that docsets should get generated and submitted on every new release.

Lastly, I'd like to store version specific docsets on nim-lang.org.

Open to feedback on the best way to have this maintained going forward.

@Araq @narimiran @dom96

cc @wicast @niv

[zah]

Yes, let's get these docsets generated with the standard Nim release/nightly build procedures.

[Araq]

@genotrance add it to nightlies?

[genotrance]

Nightlies won't work since I need to regenerate the docs with the correct links to the docs (by git hash, not devel) and it takes time to generate the docset as well. We will go over the limit we have.