Skip to content

Loading…

Make documentation generation and upload for Hackage easier #1702

Open
Fuuzetsu opened this Issue · 0 comments

2 participants

@Fuuzetsu
Haskell member

Sometimes we want to upload our own documentation to Hackage for whatever reasons. At the moment it is possible but difficult to get right: we need to generate the docs so that the pages are linked properly (including index pages &c), we need to pack the documentation up into a tarball with a proper format, we need to figure out proper curl flags etc. etc.

It's not the easiest process to go through and there's no official documentation about it (#1025): only documentation that exists is that which was put together by Haskellers. Few hacky scripts exist to help and they seem to do the job although it's far from perfect.

It'd be great if we could have a command like cabal haddock --upload or something along these lines which invokes Haddock with the correct flags and uploads the data with the correct settings if Haddock succeeds.

Alternatively, a cabal haddock --check command could be implemented which checks for badly generated docs. This should be less work but it feels like a dirty workaround for lack of official solution.

@ttuegel ttuegel referenced this issue
Closed

Cabal docdist #2156

@ttuegel ttuegel added this to the Cabal-1.24 milestone
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Something went wrong with that request. Please try again.