Re: [Haskell-cafe] Doc generation?

On Tue, Jan 19, 2016 at 04:24:24PM +1100, Noon Silk wrote:
Does anyone know what is happening here?
Not a single one of the packages on http://hackage.haskell.org/packages/recent has docs generated at the moment.
Some older ones, upload this year, also do not - http://hackage.haskell.org/package/pipes-concurrency
Docs not being built can be quite frustrating; for those dark times I build them locally: http://ariis.it/static/articles/no-docs-hackage/page.html Living with a flaky WiFi, saves me from screaming at the monitor quite some times.

I don't know what's happening with hackage, but if you're using stack in
your workflow a simple workaround is to build docs locally and search them
with a shell script. For example:
$ stack haddock async
And then muck around in .stack-work or ~/.stack. I've written a
bash/fish script to do the search for you here:
plredmond.github.io/posts/search-haddocks-offline.html
On Tuesday, January 19, 2016, Francesco Ariis
On Tue, Jan 19, 2016 at 04:24:24PM +1100, Noon Silk wrote:
Does anyone know what is happening here?
Not a single one of the packages on http://hackage.haskell.org/packages/recent has docs generated at the moment.
Some older ones, upload this year, also do not - http://hackage.haskell.org/package/pipes-concurrency
Docs not being built can be quite frustrating; for those dark times I build them locally:
http://ariis.it/static/articles/no-docs-hackage/page.html
Living with a flaky WiFi, saves me from screaming at the monitor quite some times. _______________________________________________ Haskell-Cafe mailing list Haskell-Cafe@haskell.org javascript:; http://mail.haskell.org/cgi-bin/mailman/listinfo/haskell-cafe

Also, if the packages are on stackage, you can look at the documentation
there:
https://www.stackage.org/package/pipes-concurrency
Mark
On Tue, Jan 19, 2016 at 8:39 AM, Patrick Redmond
I don't know what's happening with hackage, but if you're using stack in your workflow a simple workaround is to build docs locally and search them with a shell script. For example:
$ stack haddock async
And then muck around in .stack-work or ~/.stack. I've written a bash/fish script to do the search for you here: plredmond.github.io/posts/search-haddocks-offline.html
On Tuesday, January 19, 2016, Francesco Ariis
wrote: On Tue, Jan 19, 2016 at 04:24:24PM +1100, Noon Silk wrote:
Does anyone know what is happening here?
Not a single one of the packages on http://hackage.haskell.org/packages/recent has docs generated at the moment.
Some older ones, upload this year, also do not - http://hackage.haskell.org/package/pipes-concurrency
Docs not being built can be quite frustrating; for those dark times I build them locally:
http://ariis.it/static/articles/no-docs-hackage/page.html
Living with a flaky WiFi, saves me from screaming at the monitor quite some times. _______________________________________________ Haskell-Cafe mailing list Haskell-Cafe@haskell.org http://mail.haskell.org/cgi-bin/mailman/listinfo/haskell-cafe
_______________________________________________ Haskell-Cafe mailing list Haskell-Cafe@haskell.org http://mail.haskell.org/cgi-bin/mailman/listinfo/haskell-cafe

Thanks Mark and All,
Indeed, I've been generating the docs myself offline; I didn't know about
looking for the docs on stackage; thanks!
--
Noon
On Wed, Jan 20, 2016 at 4:51 AM, Mark Fine
Also, if the packages are on stackage, you can look at the documentation there:
https://www.stackage.org/package/pipes-concurrency
Mark
On Tue, Jan 19, 2016 at 8:39 AM, Patrick Redmond
wrote: I don't know what's happening with hackage, but if you're using stack in your workflow a simple workaround is to build docs locally and search them with a shell script. For example:
$ stack haddock async
And then muck around in .stack-work or ~/.stack. I've written a bash/fish script to do the search for you here: plredmond.github.io/posts/search-haddocks-offline.html
On Tuesday, January 19, 2016, Francesco Ariis
wrote: On Tue, Jan 19, 2016 at 04:24:24PM +1100, Noon Silk wrote:
Does anyone know what is happening here?
Not a single one of the packages on http://hackage.haskell.org/packages/recent has docs generated at the moment.
Some older ones, upload this year, also do not - http://hackage.haskell.org/package/pipes-concurrency
Docs not being built can be quite frustrating; for those dark times I build them locally:
http://ariis.it/static/articles/no-docs-hackage/page.html
Living with a flaky WiFi, saves me from screaming at the monitor quite some times. _______________________________________________ Haskell-Cafe mailing list Haskell-Cafe@haskell.org http://mail.haskell.org/cgi-bin/mailman/listinfo/haskell-cafe
_______________________________________________ Haskell-Cafe mailing list Haskell-Cafe@haskell.org http://mail.haskell.org/cgi-bin/mailman/listinfo/haskell-cafe
_______________________________________________ Haskell-Cafe mailing list Haskell-Cafe@haskell.org http://mail.haskell.org/cgi-bin/mailman/listinfo/haskell-cafe
-- Noon Silk, ن https://silky.github.io/ "Every morning when I wake up, I experience an exquisite joy — the joy of being this signature."

Hi *,
On 19 January 2016 at 23:37, Noon Silk
Thanks Mark and All,
Indeed, I've been generating the docs myself offline; I didn't know about looking for the docs on stackage; thanks!
Note that with the Git version of cabal-install you can run 'cabal upload --doc' to upload the docs to Hackage manually.

2016-01-19 23:40 GMT+01:00 Mikhail Glushenkov
Note that with the Git version of cabal-install you can run 'cabal upload --doc' to upload the docs to Hackage manually.
Are there any safeguards on the Hackage server side to guarantee consistency between the uploaded package and the uploaded docs? (i.e. make sure it's the right version etc.) Are there checks on the server side that the cross-package links are correct? Does the server make sure that the docs contain source links? If the answer to any of these questions is "no", I consider even the possibility of uploading docs by hand a bug. Wrong/partial documentation is worse than no documentation at all... Cheers, S.

Hi,
On 20 January 2016 at 08:09, Sven Panne
Are there any safeguards on the Hackage server side to guarantee consistency between the uploaded package and the uploaded docs? (i.e. make sure it's the right version etc.) Are there checks on the server side that the cross-package links are correct? Does the server make sure that the docs contain source links?
If I'm reading [1] correctly, no such checks are performed.
If the answer to any of these questions is "no", I consider even the possibility of uploading docs by hand a bug. Wrong/partial documentation is worse than no documentation at all...
You're welcome to open a ticket on the hackage-server bug tracker. [1] https://github.com/haskell/hackage-server/blob/master/Distribution/Server/Fe...

2016-01-20 8:35 GMT+01:00 Mikhail Glushenkov
You're welcome to open a ticket on the hackage-server bug tracker.
From a packager maintainer POV, it's totally unpredictable if/when documentation gets built, see e.g. http://hackage.haskell.org/package/GLURaw-2.0.0.1: Currently there are no docs, while the previous version had docs, and the only change was relaxing
I've reported this several times through several channels, not sure if yet another report will have an impact. Here a quick summary of doc-generation-related issues: https://github.com/haskell/hackage-server/issues/464 https://github.com/haskell/hackage-server/issues/463 https://github.com/haskell/hackage-server/issues/421 https://github.com/haskell/hackage-server/issues/420 https://github.com/haskell/hackage-server/issues/368 https://github.com/haskell/hackage-server/issues/244 https://github.com/haskell/hackage-server/issues/183 https://github.com/haskell/hackage-server/issues/145 https://github.com/haskell/hackage-server/issues/55 the upper bound of OpenGLRaw ( https://github.com/haskell-opengl/GLURaw/compare/v2.0.0.0...v2.0.0.1). Basically I gave up any hope and rely on stackage and/or local docs... :-( Cheers, S.

Hi,
On 20 January 2016 at 09:49, Sven Panne
2016-01-20 8:35 GMT+01:00 Mikhail Glushenkov
: You're welcome to open a ticket on the hackage-server bug tracker.
I've reported this several times through several channels
Those tickets are about missing docs, not missing checks of manually uploaded docs.

2016-01-20 10:11 GMT+01:00 Mikhail Glushenkov
Those tickets are about missing docs, not missing checks of manually uploaded docs.
Ah, OK, then we misunderstood each other. My point is: If doc generation actually worked on Hackage, the manual upload could be disabled immediately, I see it only as a fragile workaround, so there is no point in opening a ticket for improving that when we already have tons of tickets for the *real* problem (which somehow seems to be ignored for ages). Cheers, S.

This would require the ability to re-upload a package that only has
documentation changes. I regularly re-upload documentation when people
report a documentation bug (such as a typo). I wouldn't want to lose that
ability.
On Wed, Jan 20, 2016 at 10:46 AM Sven Panne
2016-01-20 10:11 GMT+01:00 Mikhail Glushenkov < mikhail.glushenkov@gmail.com>:
Those tickets are about missing docs, not missing checks of manually uploaded docs.
Ah, OK, then we misunderstood each other. My point is: If doc generation actually worked on Hackage, the manual upload could be disabled immediately, I see it only as a fragile workaround, so there is no point in opening a ticket for improving that when we already have tons of tickets for the *real* problem (which somehow seems to be ignored for ages).
Cheers, S. _______________________________________________ Haskell-Cafe mailing list Haskell-Cafe@haskell.org http://mail.haskell.org/cgi-bin/mailman/listinfo/haskell-cafe

Note that if you do this, people who install your package will locally
still have the documentation bug, so it's probably better to upload a
new version anyway.
Erik
On 20 January 2016 at 13:41, Oliver Charles
This would require the ability to re-upload a package that only has documentation changes. I regularly re-upload documentation when people report a documentation bug (such as a typo). I wouldn't want to lose that ability.
On Wed, Jan 20, 2016 at 10:46 AM Sven Panne
wrote: 2016-01-20 10:11 GMT+01:00 Mikhail Glushenkov
: Those tickets are about missing docs, not missing checks of manually uploaded docs.
Ah, OK, then we misunderstood each other. My point is: If doc generation actually worked on Hackage, the manual upload could be disabled immediately, I see it only as a fragile workaround, so there is no point in opening a ticket for improving that when we already have tons of tickets for the *real* problem (which somehow seems to be ignored for ages).
Cheers, S. _______________________________________________ Haskell-Cafe mailing list Haskell-Cafe@haskell.org http://mail.haskell.org/cgi-bin/mailman/listinfo/haskell-cafe
_______________________________________________ Haskell-Cafe mailing list Haskell-Cafe@haskell.org http://mail.haskell.org/cgi-bin/mailman/listinfo/haskell-cafe
participants (8)
-
Erik Hesselink
-
Francesco Ariis
-
Mark Fine
-
Mikhail Glushenkov
-
Noon Silk
-
Oliver Charles
-
Patrick Redmond
-
Sven Panne