Possible to generate docs for unpublished code?

[techieshark]

I've generated a documentation.json file using elm-make --docs=documentation.json and can preview it using this tool, but I'd like to have a local copy of it (this code is part of a web app in development and it doesn't make sense to publish these modules, so getting the code in Elm's online documentation isn't sensible).

I'd like to include this in doc viewers that take docsets, like Dash or Zeal.

Is it possible to use your elm-docset tool to generate a new docset that includes an unpublished documentation.json file?

Thank you.

[pdamoc]

It's not possible right now to generate docs for unpublished code but should not be all that difficult to implement since the script consumes the same kind of information. For the sake of clarity, do you want the script to generate a custom Elm docset that includes the unpublished documentation OR do you want the script to be able to produce individual docsets based on a documentation.json?

[techieshark]

Hi Petre,

Either of those options you mention would be fine I think (assuming I could load either in Dash locally -- I wouldn't be trying to upload anything to the public Dash docset collection).

To allow my local documentation to include links from it to standard types (Maybe, Html etc) I assume we'd have to generate the docset for all of Elm, but if it's possible to link from one docset to another then generating just the individual docset for the project would be fine.

Thanks.

[pdamoc]

I don't know how to add links to other docsets (I don't even know if that's possible) For now, I'll think about just adding the extra documentation.json to a regular Elm docset and will proceed from there if other needs arise.

Thank you for this issue.