Skip to content

Commit

Permalink
update readme with dune trick
Browse files Browse the repository at this point in the history
  • Loading branch information
EmileTrotignon committed Feb 7, 2024
1 parent 80ded5e commit d222c61
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ $ opam install ancient
$ export SHERLODOC_DB=/tmp/sherlodoc.ancient

# index all odoc files generated by odig for your current switch:
$ sherlodoc index $(find $OPAM_SWITCH_PREFIX/var/cache/odig/odoc -name '*.odocl')
$ sherlodoc index $(find $OPAM_SWITCH_PREFIX/var/cache/odig/odoc -name '*.odocl' | grep -v __)
```

Enjoy searching from the command-line or run the webserver:
Expand Down Expand Up @@ -70,7 +70,7 @@ Otherwise, manual integration with odoc requires to add to every call of `odoc h

```bash
$ sherlodoc index --db=_build/default/_doc/_html/YOUR_LIB/db.js \
$(find _build/default/_doc/_odocls/YOUR_LIB -name '*.odocl')
$(find _build/default/_doc/_odocls/YOUR_LIB -name '*.odocl' | grep -v __)

$ sherlodoc js > _build/default/_doc/_html/sherlodoc.js
```
Expand Down

0 comments on commit d222c61

Please sign in to comment.