[Haskell-cafe] Documenting Examples for a library

[Guru Devanla]

Thanks Ivan. I did end up using the markdown-unlit library as suggested in
this post:

https://www.reddit.com/r/haskell/comments/84mirm/recommended_way_of_documenting_examples/?st=jevg0jg6&sh=bd7e6804

On Thu, Mar 15, 2018 at 7:04 PM, Ivan Lazar Miljenovic <
ivan.miljenovic at gmail.com> wrote:

> On 16 March 2018 at 00:23, Guru Devanla <gurudev.devanla at gmail.com> wrote:
> > 3. Using Example.lhs. I like this approach since it lets me load the
> code in
> > ghci and test out the examples seamlessly. But, I am hitting roadblocks
> with
> > this, since I am not able to include this file as part of my stack
> project.
> > `stack haddock` fails too.
>
> One option is to have this as a separate executable but not marked as
> buildable by default; for example:
> https://github.com/ivan-m/testbench/blob/master/testbench.cabal#L39
> (my .travis.yml enables the flag so I can be sure it still works).
>
>
> --
> Ivan Lazar Miljenovic
> Ivan.Miljenovic at gmail.com
> http://IvanMiljenovic.wordpress.com
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.haskell.org/pipermail/haskell-cafe/attachments/20180317/587d8ae5/attachment.html>