Using scripths to generate documentation of a Haskell project

[tchoutri]

Hi @mchav! I'd like to use scripths in the documentation process of a Haskell tool at work. I want to put in my MANUAL.md all the possible values of an enum defined in this project (in a visible public sub-library, so with the format project:project-core).

However using cabal directives in the source markdown, I get unknown package.

Is there a way to make scripths discover the local project while operating on a markdown notebook?

[mchav]

Possible in principle. The way it works is that it creates a project.cabal file in a tmp folder with the deps you specify in the directive. For local deps we'd have to also create a cabal project as well that references the local files. Doable but haven't thought about how you'd specify local deps differently from hackage deps.

Open to suggestions for what would be ergonomic. My intial thought would be to have a sepate oackage source directive but I want to hold off and think through this a little more so it's more robust.

[tchoutri]

Maybe it could be interesting to see how https://flora.pm/packages/@hackage/doctest does it?

[mchav]

Worked on this over the weekend. Decided to:

1. Have scripths read local cabal.project env by default (unless you specify --no-local-project explicitly)
2. If there are any packages you want to include too you can do scripths -package ../dataframe -o res.md base.md

[tchoutri]

@mchav I saw the release yes! I'm now getting further, but I have some issues with the fact that my project uses a custom prelude + backpack. Happy to pair with you on this when/if you can. :)