Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jsoo sherlodoc #4

Merged
merged 250 commits into from Feb 2, 2024
Merged

Jsoo sherlodoc #4

merged 250 commits into from Feb 2, 2024

Conversation

EmileTrotignon
Copy link
Collaborator

@EmileTrotignon EmileTrotignon commented Oct 16, 2023

This contains a lot of changes. I will try to broadly describe them.

  • Compatibility with odoc, that is this version : Support for search in odoc ocaml/odoc#972
  • Searching things that are not values : modules, types, constructors, and type-based search where applicable
  • js_of_ocaml version that conforms to the protocol outlined by odoc pr 972.
  • There is a new data structure to store the results that has better performance both in space and time.
  • There is a cli version of the search that was written for testing purposes but that can probably be used as a standalone tool.

I have probably forgotten some things, I will come back and add details later.

EmileTrotignon and others added 4 commits January 31, 2024 15:53
* make test on base faster by making the slowest part cachable by dune

* do not call odig inside cram tests : this is important because odig can have issues

---------

Co-authored-by: Emile Trotignon <emile@tarides.com>
@art-w
Copy link
Owner

art-w commented Feb 2, 2024

Thanks again for all the work! ❤️

It's been deployed to doc.sherlocode.com a few days ago and seems to work well enough... so let's merge! Any remaining issues can be addressed in follow-up PRs :)

@art-w art-w merged commit 1034f9e into master Feb 2, 2024
1 check was pending
@art-w art-w deleted the jsoo branch February 2, 2024 09:47
art-w added a commit that referenced this pull request Feb 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants