purescript-contrib / pulp

A build tool for PureScript projects
GNU Lesser General Public License v3.0
443 stars 86 forks source link

How can I get the docs generator to just generate docs for my files #414

Open jstoxrocky opened 1 year ago

jstoxrocky commented 1 year ago

When I run pulp docs -- --format html, and then check out the resulting HTML, I see that the command has generated docs for all my dependecies as well and placed them under the Modules header...

Screen Shot 2023-03-04 at 1 43 50 PM

This isn't what we want right? Am I building my project in some weird way that causes this? This is what my output folder looks like...Is it pulling from there? How can I get the docs generator to just generate docs for my files?

Screen Shot 2023-03-04 at 1 45 39 PM
JordanMartinez commented 1 year ago

AFAIK, you don't. The docs are generated for everything.

However, if you use spago, then spago docs will group modules under their package, so you can find the package representing your code and look only in that grouping.

jstoxrocky commented 1 year ago

Should I use spago? @JordanMartinez I was just following the instructions here: https://pursuit.purescript.org/help/authors#submitting-packages

JordanMartinez commented 1 year ago

Ah... Yeah, those instructions are outdated. See https://discourse.purescript.org/t/registry-alpha-launched/3146