search

dmy / elm-doc-preview

Elm offline documentation previewer
https://www.npmjs.com/package/elm-doc-preview
Other
127 stars 15 forks source link

Generate documentation for application source #17

Closed domenkozar closed 5 years ago

domenkozar commented 5 years ago

I have a couple of forked packages in my application, it would be great if I could browse those as well. Is there an elm limitation or it's just not implemented yet?

rlefevre commented 5 years ago

I don't think there is anything preventing this and I intend to implement it in the next release, but only for applications (this is most likely the main use cases of forked packages anyway).

What I had in mind is to search for elm.json files in all parent directories of source-directories and build their documentation if they are packages.

This would actually also allow to build an application documentation by organizing it in one or several sub-packages.

domenkozar commented 5 years ago

I see now https://github.com/elm/compiler/issues/1835. It's a bit of shame, but here we are.

Your approach sounds good to me!

rlefevre commented 5 years ago

Applications, including forked and local packages used with source-directories are now fully supported in 3.0.0-rc1 and later.