File: run.t

package info (click to toggle)
ocaml-odoc 3.0.0-2
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 12,104 kB
  • sloc: ml: 59,291; javascript: 2,572; sh: 566; makefile: 31
file content (12 lines) | stat: -rw-r--r-- 479 bytes parent folder | download | duplicates (2) 
1
2
3
4
5
6
7
8
9
10
11
12
 
  $ ocamlc -c a.mli -bin-annot -I .
  $ odoc compile -I . a.cmti
  $ odoc link -I . a.odoc
  $ export SHERLODOC_DB=db.bin
  $ export SHERLODOC_FORMAT=marshal
  $ sherlodoc index $(find . -name '*.odocl')
  $ sherlodoc search --print-docstring "foo"
  val A.foo : int
  <div><p>This is a docstring with a <span>link</span></p></div>
  $ sherlodoc search --print-docstring "bar"
  val A.bar : int
  <div><p>This is a docstring with a ref to <span><code>foo</code></span></p></div>