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

Already on GitHub? Sign in to your account

Make documentation generation and upload for Hackage easier #1702

Closed
Fuuzetsu opened this Issue Feb 24, 2014 · 1 comment

Comments

Projects
None yet
3 participants
Member

Fuuzetsu commented Feb 24, 2014

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 Feb 28, 2015

Closed

Cabal docdist #2156

@ttuegel ttuegel added this to the Cabal-1.24 milestone Apr 23, 2015

@23Skidoo 23Skidoo modified the milestones: Cabal 1.24, Cabal 1.26 Feb 21, 2016

Member

23Skidoo commented Feb 21, 2016

This has been fixed in #2890.

@23Skidoo 23Skidoo closed this Feb 21, 2016

@23Skidoo 23Skidoo modified the milestones: cabal-install 1.24, Cabal 1.26 Mar 18, 2016

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