File: run.t

package info (click to toggle)
ocaml-odoc 3.1.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 14,008 kB
  • sloc: ml: 60,567; javascript: 2,572; sh: 566; makefile: 31
file content (22 lines) | stat: -rw-r--r-- 774 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
Imitate the way the stdlib is built and how its documentation should be built.

  $ ocamlc -c -no-alias-deps -bin-annot -w -49 -o main.cmti main.mli
  $ ocamlc -c -bin-annot -I . -o main__x.cmti x.mli

'Main' doesn't depend on 'Main__x':

  $ odoc compile-deps main.cmti | grep Main__x
  [1]

  $ odoc compile --pkg ocaml -o main.odoc main.cmti -I .
  File "main.mli", line 3, characters 4-17:
  Warning: Canonical paths must contain a dot, eg. X.Y.
  $ odoc compile --pkg ocaml -o main__x.odoc main__x.cmti -I .

  $ odoc html --indent -o html main__x.odoc -I .
  $ odoc html --indent -o html main.odoc -I .

The page for Main should include the synopsis from X:

  $ cat html/ocaml/Main/index.html | grep "Synopsis"
      </div><div class="spec-doc"><p>Synopsis</p></div>