odoc
odoc copied to clipboard
Doc sherlodoc
This is two things rebases https://github.com/ocaml/odoc/pull/1064, and update the sherlodoc interface to the definitive one released in sherlodoc.
This gives the benefits that stdlib results are not shown above odoc ones anymore.
It would be a bad idea to merge this because the driver would be hard to run properly: you need to have sherlodoc installed and linked to the current odoc version which is challenging during development.
I removed this from draft because the concern I had is not a big deal. If you have sherlodoc linked to the wrong odoc, there wont be a diff in the driver, because its the content of the .js file that will be different. This should probably explained and documented, but it is not a blocker for merging.
Thanks!
I left some minor comments.
This should probably explained and documented, but it is not a blocker for merging.
I think it is a blocker for merging! I tried to make it work (
dune -p odoc @install
thenopam install sherlodoc
thendune build @docgen
) and failed.
I think @install build the required file that should be installed, its "dune install" taht actually install them. Regardless, it should not fail.
I said it should not block merging because it thought it would not fail, but instead just produce a wrong output, but apparentyl this is false.
I am closing this because the driver has been completely rewritten.