Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
jstoxrocky opened this issue Mar 4, 2023 · 3 comments
Open

Comments

@jstoxrocky
Copy link

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
Copy link
Member

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
Copy link
Author

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

@JordanMartinez
Copy link
Member

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

2 participants