Skip to content

Documentation building broken/off? #265

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
conal opened this issue Sep 24, 2014 · 18 comments
Closed

Documentation building broken/off? #265

conal opened this issue Sep 24, 2014 · 18 comments

Comments

@conal
Copy link

conal commented Sep 24, 2014

Is Haddock documentation building on Hackage broken (or turned off)? I released Boolean-0.2.2 last week, and no documentation is showing up, nor any error log.

@Daniel-Diaz
Copy link

If you look at your build reports page, there is no build reported.

I had the same issue with several packages I uploaded these last weeks. This one was uploaded September 10, but there are no reports yet.

I asked in #hackage. They recommend to manually upload the docs.

@conal
Copy link
Author

conal commented Sep 24, 2014

@Daniel-Diaz Thanks for the tip. How did you know about build reports?

@Daniel-Diaz
Copy link

@conal You can find this and much more in the Hackage API docs.

@conal
Copy link
Author

conal commented Sep 24, 2014

@Daniel-Diaz Cool. Thanks!

@conal
Copy link
Author

conal commented Sep 24, 2014

I found some doc upload instructions I found, but they don't work on my (Mac OS) machine. I don't know what else to try.

@lambda-fairy
Copy link
Contributor

@conal What problems did you encounter? I found this comment which might help.

@bitemyapp
Copy link
Contributor

@conal I derived step-by-step instructions for uploading docs based on Fuuzetsu's post (required some tweaking), I use them for Bloodhound here:

https://github.com/bitemyapp/bloodhound/blob/master/Makefile#L30-L35 and https://github.com/bitemyapp/bloodhound/blob/master/gen-docs.sh

If you want a fully automated script, glguy then derived a script from my Makefile and Fuuzetsu's post here for lens:

https://github.com/ekmett/lens/blob/master/scripts/hackage-docs.sh

I'd strongly recommend anybody needing to upload hackage docs be pointed to that script or a variation of it.

I often work on a Mac, so I know that at least my manual documentation of it in my Makefile works, I can only assume glguy's script works for Mac users as well but I don't know for sure. The gen-docs.sh stuff is separate of the Makefile because of escaping issues.

@emmanueltouzery
Copy link

I uploaded http://hackage.haskell.org/package/app-settings-0.2.0.3 already many hours ago and also no docs.. There's a real problem here....

@ryantm
Copy link

ryantm commented Oct 19, 2014

It looks like this has been resolved and can be closed.

@crockeea
Copy link

It looks like all the examples I found have been updated, but do we know why/has the problem been fixed?

@svenpanne
Copy link

I don't think this issue should be closed, the documentation is still not being built, see e.g.

http://hackage.haskell.org/package/StateVar-1.0.1.0
http://hackage.haskell.org/package/ObjectName-1.0.1.0
http://hackage.haskell.org/package/Tensor-1.1.0.0

I've uploaded those versions 5 days ago, and I still don't have a clue what's going on... :-/

@crockeea
Copy link

Has anyone looked into this (or #244) recently? Two of the three links from the previous comment still don't have docs.

@crockeea
Copy link

This is still a problem. I uploaded a new version of lol last week, but still no docs. Status is "Docs Pending".

@crockeea
Copy link

crockeea commented Dec 7, 2015

I also "deleted the documentation and triggered a rebuild" on lol, to no avail. The differences between the previous version of the library (where Hackage build the documentation fine) is tiny, so I can't imagine what the probem is. Can we get someone to dig through server logs somewhere and figure out what the holdup on doc generation is?

@gbaz
Copy link
Contributor

gbaz commented Feb 3, 2016

closing this as its an old ticket.

@gbaz gbaz closed this as completed Feb 3, 2016
@gbaz
Copy link
Contributor

gbaz commented Feb 3, 2016

(it would be better to not use this one ticket for all docbuilder issues)

@crockeea
Copy link

crockeea commented Feb 4, 2016

@gbaz Can you link to a newer ticket? I posted #244, and you've also closed this ticket. Both address documentation not being built, which is still a very big problem. Is this issue being addressed somewhere else?

@gbaz
Copy link
Contributor

gbaz commented Jun 15, 2016

sorry i missed this -- clearing out old emails now. here's the ticket to track the general issue: #478

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

No branches or pull requests

9 participants