art-w / sherlodoc

Fuzzy type search for OCaml documentation
MIT License
70 stars 6 forks source link

Enable sherlodoc on .odoc-index file for odoc 3 compat #42

Open EmileTrotignon opened 3 months ago

EmileTrotignon commented 3 months ago

This adds support for the future odoc 3, which include generating .odoc-index files for sherlodoc to consume instead of consuming .odocl files directly.

It works with the following odoc PR : https://github.com/ocaml/odoc/pull/1084

art-w commented 2 months ago

Would it be possible to add a little test to generate an .odoc-index and a pin to the odoc PR in sherlodoc, such that the CI will run? Thanks! :)

art-w commented 1 week ago

The CI seems to report errors with the latest odoc CLI which I'm not familiar with... Any ideas on how to update the cram tests? :)

EmileTrotignon commented 1 week ago

If I understand correctly the CI uses regular odoc, instead of the latest version from master. The corresponding PR in odoc is merged, so a pin on master should fix this.