art-w / sherlodoc

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

add option to choose whether stdlib entries are favoured #9

Closed EmileTrotignon closed 9 months ago

EmileTrotignon commented 9 months ago

This is useful for integration with dune .

The new odoc rules (target @doc-new) are meant to be a view of the docs for the dev of the library , not for the users : it build the doc of the dependencies and of private libs by default. This also means that its not the best rules for uploading the doc on github pages.

Therefore, Jon and I agreed that for this target, the scope of the search needs to include everything. There is an issue with that, which that the stdlib is always a dependency, and the results from it are favoured. This PR adds a flag to control this.

Long term, I would like to have a way to specify favoured packages, but I think disabling it for the stdlib is enough for now.