Skip to content

what step is needed to get the .tar.gz for uploading haddocks? #5821

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

Open
cartazio opened this issue Jan 1, 2019 · 8 comments
Open

what step is needed to get the .tar.gz for uploading haddocks? #5821

cartazio opened this issue Jan 1, 2019 · 8 comments

Comments

@cartazio
Copy link
Contributor

cartazio commented Jan 1, 2019

This doesn't seem to be documented anywhere, but implicit in the help messages for upload. WHere do i look to find this information?

@typedrat
Copy link
Collaborator

typedrat commented Jan 1, 2019

cabal v2-sdist?

@cartazio
Copy link
Contributor Author

cartazio commented Jan 2, 2019

sdist doesn't run haddock ... what sequence of actions do i need to do go get a haddock targz for then uploading docs to hackage for something which wont build on the hackage environment?

goal: i want to be able to do cabal upload --publish --documentation.

at least with cabal 2.4, theres no mentions of haddocks in v2-sdist.

What is the documented way to generate the haddocks into a tar file for upload using cabal? (theres lots of old scripts for doing this, i'm just confused that we have only half of the work flow documented in the cabal CLI ... )

am i overlooking something obvious?

@typedrat
Copy link
Collaborator

typedrat commented Jan 2, 2019

Oh, that's just me being unable to read. Ignore my response, I don't know the answer off the top of my head.

@gbaz
Copy link
Collaborator

gbaz commented Jan 2, 2019

here, with bells and whistles on: cabal new-haddock --haddock-for-hackage --haddock-hyperlink-source --haddock-quickjump

I agree we should document this better.

@harpocrates
Copy link
Collaborator

@gbaz I believe that --haddock-for-hackage now implies --haddock-hyperlink-source and --haddock-quickjump, so cabal new-haddock --haddock-for-hackage should suffice.

@cartazio
Copy link
Contributor Author

cartazio commented Jan 2, 2019 via email

@harpocrates
Copy link
Collaborator

harpocrates commented Jan 2, 2019 via email

@cartazio
Copy link
Contributor Author

cartazio commented Jan 2, 2019 via email

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

No branches or pull requests

6 participants