Skip to content

Make documentation generation and upload for Hackage easier #1702

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

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

Make documentation generation and upload for Hackage easier #1702

Fuuzetsu opened this issue Feb 24, 2014 · 1 comment

Comments

@Fuuzetsu
Copy link
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.

@23Skidoo
Copy link
Member

This has been fixed in #2890.

@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
Projects
None yet
Development

No branches or pull requests

3 participants