Link to "canceable" broken

[arvidj]

On https://ocsigen.org/lwt/latest/api/Lwt#2_Cancellation there is a link to https://ocsigen.org/#VALcancel . This link is broken.

[raphael-proust]

Thanks for the report. There are other broken links (e.g., let%lwt is a link to https://ocsigen.org/#VALbind which is broken in the same way).

It should point to https://ocsigen.org/lwt/latest/api/Lwt#VALcancel (and similarly https://ocsigen.org/lwt/latest/api/Lwt#VALbind).

---

The doc generation in this project is somewhat convoluted so I'm putting this aside for now and I'll come back to this issue later.

[arvidj]

I had a look at this. As you suggest, it wasn't as easy as one would expect. The issue is that the HTML contains links like
<a href=" /#VALcancel" class="ocsimore_phrasing_link"> cancelable</a>
Note that the href is /#... i.e. it starts with a spurious space and slash. It seems this is the part to remove to make the link valid. On the documentation comment level, this seems to come from links on the form {{!Lwt.cancel} cancelable}, i.e. where the link text for a reference is customized. I couldn't figure out from where this comes since I couldn't actually figure out how the documentation published at https://ocsigen.org/lwt/latest/api/Lwt is generated. If I build the documentation locally, using either dune build @doc or make doc-api-html, then I do not have this issue. I think the issue is somewhere in wikidoc.

[arvidj]

The issue seems to be in the generated .wiki files iiuc:
https://github.com/ocsigen/lwt/blob/wikidoc/docs/5.5.0/api/Lwt.wiki?plain=1#L1227 has

[[ #VALcancel| cancelable]]~.

[arvidj]

However, when I regenerate the wiki files locally, I do not get the same markup. Instead, I get:

<<a_api text=" cancelable" | val Lwt.cancel >>~.

which is perhaps the correct syntax? So the issue may be an old wikidoc version?

[arvidj]

Aha! I noticed that this has actually already been fixed in #928. The reason that we see it on https://ocsigen.org/lwt/latest/api/Lwt is the most recently published documentation is for 5.5.0, and the fix is in 5.6.0. So the easy fix should be to publish the documentation for 5.6.0 and 5.7.0.