🎉 Odoc 3 🎉
🏰 Offsite 2024 🏰
📖 Documentation team 📖
First encounter with odoc
Let's build some doc by hand!
odoc compile-deps ~/.opam/5.2.0/lib/ocaml/stdlib__Arg.cmti
odoc compile-deps ~/.opam/5.2.0/lib/ocaml/stdlib.cmti
odoc compile-deps ~/.opam/5.2.0/lib/ocaml/camlinternalOO.cmti
odoc compile-deps ~/.opam/5.2.0/lib/ocaml/camlinternalMod.cmti
odoc compile-deps ~/.opam/5.2.0/lib/ocaml/camlinternalLazy.cmti
odoc compile-deps ~/.opam/5.2.0/lib/ocaml/camlinternalFormatBasics.cmti
odoc compile-deps ~/.opam/5.2.0/lib/ocaml/stdlib__Atomic.cmti
odoc compile-deps ~/.opam/5.2.0/lib/ocaml/stdlib__ArrayLabels.cmti
odoc compile-deps ~/.opam/5.2.0/lib/ocaml/stdlib__Array.cmti
odoc compile-deps ~/.opam/5.2.0/lib/ocaml/stdlib__Bool.cmti
odoc compile-deps ~/.opam/5.2.0/lib/ocaml/stdlib__Bigarray.cmti
odoc compile-deps ~/.opam/5.2.0/lib/ocaml/stdlib__Buffer.cmti
odoc compile-deps ~/.opam/5.2.0/lib/ocaml/stdlib__Bytes.cmti
odoc compile-deps ~/.opam/5.2.0/lib/ocaml/stdlib__BytesLabels.cmti
odoc compile-deps ~/.opam/5.2.0/lib/ocaml/camlinternalFormat.cmti
odoc compile-deps ~/.opam/5.2.0/lib/ocaml/stdlib__Callback.cmti
odoc compile-deps ~/.opam/5.2.0/lib/ocaml/stdlib__Char.cmti
odoc compile-deps ~/.opam/5.2.0/lib/ocaml/stdlib__Condition.cmti
odoc compile-deps ~/.opam/5.2.0/lib/ocaml/stdlib__Complex.cmti
odoc compile-deps ~/.opam/5.2.0/lib/ocaml/stdlib__Digest.cmti
odoc compile-deps ~/.opam/5.2.0/lib/ocaml/stdlib__Domain.cmti
odoc compile-deps ~/.opam/5.2.0/lib/ocaml/stdlib__Effect.cmti
odoc compile-deps ~/.opam/5.2.0/lib/ocaml/stdlib__Dynarray.cmti
odoc compile-deps ~/.opam/5.2.0/lib/ocaml/stdlib__Either.cmti
odoc compile-deps ~/.opam/5.2.0/lib/ocaml/stdlib__Filename.cmti
odoc compile-deps ~/.opam/5.2.0/lib/ocaml/stdlib__Ephemeron.cmti
odoc compile-deps ~/.opam/5.2.0/lib/ocaml/stdlib__Float.cmti
odoc compile-deps ~/.opam/5.2.0/lib/ocaml/stdlib__Format.cmti
odoc compile-deps ~/.opam/5.2.0/lib/ocaml/stdlib__Fun.cmti
odoc compile-deps ~/.opam/5.2.0/lib/ocaml/stdlib__Gc.cmti
odoc compile-deps ~/.opam/5.2.0/lib/ocaml/stdlib__Hashtbl.cmti
odoc compile-deps ~/.opam/5.2.0/lib/ocaml/stdlib__In_channel.cmti
odoc compile-deps ~/.opam/5.2.0/lib/ocaml/stdlib__Int.cmti
odoc compile-deps ~/.opam/5.2.0/lib/ocaml/stdlib__Int32.cmti
odoc compile-deps ~/.opam/5.2.0/lib/ocaml/stdlib__Int64.cmti
odoc compile-deps ~/.opam/5.2.0/lib/ocaml/stdlib__Lexing.cmti
odoc compile-deps ~/.opam/5.2.0/lib/ocaml/stdlib__ListLabels.cmti
odoc compile-deps ~/.opam/5.2.0/lib/ocaml/stdlib__Lazy.cmti
odoc compile-deps ~/.opam/5.2.0/lib/ocaml/stdlib__List.cmti
odoc compile-deps ~/.opam/5.2.0/lib/ocaml/stdlib__Marshal.cmti
odoc compile-deps ~/.opam/5.2.0/lib/ocaml/stdlib__MoreLabels.cmti
odoc compile-deps ~/.opam/5.2.0/lib/ocaml/stdlib__Mutex.cmti
odoc compile-deps ~/.opam/5.2.0/lib/ocaml/stdlib__Map.cmti
odoc compile-deps ~/.opam/5.2.0/lib/ocaml/stdlib__Nativeint.cmti
odoc compile-deps ~/.opam/5.2.0/lib/ocaml/stdlib__Obj.cmti
odoc compile-deps ~/.opam/5.2.0/lib/ocaml/stdlib__Oo.cmti
odoc compile-deps ~/.opam/5.2.0/lib/ocaml/stdlib__Option.cmti
odoc compile-deps ~/.opam/5.2.0/lib/ocaml/stdlib__Parsing.cmti
odoc compile-deps ~/.opam/5.2.0/lib/ocaml/stdlib__Out_channel.cmti
odoc compile-deps ~/.opam/5.2.0/lib/ocaml/stdlib__Printexc.cmti
odoc compile-deps ~/.opam/5.2.0/lib/ocaml/stdlib__Printf.cmti
odoc compile-deps ~/.opam/5.2.0/lib/ocaml/stdlib__Random.cmti
odoc compile-deps ~/.opam/5.2.0/lib/ocaml/stdlib__Queue.cmti
odoc compile-deps ~/.opam/5.2.0/lib/ocaml/stdlib__Result.cmti
odoc compile-deps ~/.opam/5.2.0/lib/ocaml/stdlib__Semaphore.cmti
odoc compile-deps ~/.opam/5.2.0/lib/ocaml/stdlib__Set.cmti
odoc compile-deps ~/.opam/5.2.0/lib/ocaml/stdlib__Scanf.cmti
odoc compile-deps ~/.opam/5.2.0/lib/ocaml/stdlib__StdLabels.cmti
odoc compile-deps ~/.opam/5.2.0/lib/ocaml/stdlib__String.cmti
odoc compile-deps ~/.opam/5.2.0/lib/ocaml/stdlib__Seq.cmti
odoc compile-deps ~/.opam/5.2.0/lib/ocaml/stdlib__Stack.cmti
odoc compile-deps ~/.opam/5.2.0/lib/ocaml/stdlib__StringLabels.cmti
odoc compile-deps ~/.opam/5.2.0/lib/ocaml/stdlib__Type.cmti
odoc compile-deps ~/.opam/5.2.0/lib/ocaml/stdlib__Sys.cmti
odoc compile-deps ~/.opam/5.2.0/lib/ocaml/stdlib__Unit.cmti
odoc compile-deps ~/.opam/5.2.0/lib/ocaml/stdlib__Uchar.cmti
odoc compile-deps ~/.opam/5.2.0/lib/ocaml/stdlib__Weak.cmti
odoc classify ~/.opam/5.2.0/lib/re/
odoc compile-deps ~/.opam/5.2.0/lib/re/re__Emacs.cmti
odoc compile-deps ~/.opam/5.2.0/lib/re/re__Cset.cmti
odoc compile-deps ~/.opam/5.2.0/lib/re/re__Color_map.cmti
odoc compile-deps ~/.opam/5.2.0/lib/re/re__Category.cmti
odoc compile-deps ~/.opam/5.2.0/lib/re/re__Fmt.cmt
odoc compile-deps ~/.opam/5.2.0/lib/re/re__.cmt
odoc compile-deps ~/.opam/5.2.0/lib/re/re__Automata.cmti
odoc compile-deps ~/.opam/5.2.0/lib/re/re.cmt
odoc compile-deps ~/.opam/5.2.0/lib/re/re__Glob.cmti
odoc compile-deps ~/.opam/5.2.0/lib/re/re__Group.cmti
odoc compile-deps ~/.opam/5.2.0/lib/re/re__Pmark.cmti
odoc compile-deps ~/.opam/5.2.0/lib/re/re__Pcre.cmti
odoc compile-deps ~/.opam/5.2.0/lib/re/re__Perl.cmti
odoc compile-deps ~/.opam/5.2.0/lib/re/re__Core.cmti
odoc compile-deps ~/.opam/5.2.0/lib/re/re__Posix.cmti
odoc compile-deps ~/.opam/5.2.0/lib/re/re__Str.cmti
odoc classify ~/.opam/5.2.0/lib/tyxml/
odoc compile-deps ~/.opam/5.2.0/lib/tyxml/tyxml.cmt
odoc compile-deps ~/.opam/5.2.0/lib/tyxml/tyxml_xml.cmti
odoc compile-deps ~/.opam/5.2.0/lib/tyxml/tyxml_svg.cmti
odoc compile-deps ~/.opam/5.2.0/lib/tyxml/tyxml_html.cmti
odoc classify ~/.opam/5.2.0/lib/tyxml/functor/
odoc compile-deps ~/.opam/5.2.0/lib/tyxml/functor/svg_types.cmti
odoc compile-deps ~/.opam/5.2.0/lib/tyxml/functor/html_types.cmti
odoc compile-deps ~/.opam/5.2.0/lib/tyxml/functor/svg_sigs.cmti
odoc compile-deps ~/.opam/5.2.0/lib/tyxml/functor/xml_sigs.cmti
odoc compile-deps ~/.opam/5.2.0/lib/tyxml/functor/html_sigs.cmti
odoc compile-deps ~/.opam/5.2.0/lib/tyxml/functor/xml_iter.cmti
odoc compile-deps ~/.opam/5.2.0/lib/tyxml/functor/xml_stream.cmti
odoc compile-deps ~/.opam/5.2.0/lib/tyxml/functor/svg_f.cmti
odoc compile-deps ~/.opam/5.2.0/lib/tyxml/functor/xml_print.cmti
odoc compile-deps ~/.opam/5.2.0/lib/tyxml/functor/xml_wrap.cmti
odoc compile-deps ~/.opam/5.2.0/lib/tyxml/functor/html_f.cmti
odoc classify ~/.opam/5.2.0/lib/uutf/
odoc compile-deps ~/.opam/5.2.0/lib/uutf/uutf.cmti
odoc compile-impl ~/.opam/5.2.0/lib/re/re__.cmt --output-dir _odoc/ -I _odoc/ --enable-missing-root-warning --parent-id re/lib/re --source-id re/src/re/re__.ml
odoc compile-impl ~/.opam/5.2.0/lib/ocaml/camlinternalFormatBasics.cmt --output-dir _odoc/ -I _odoc/ --enable-missing-root-warning --parent-id ocaml-base-compiler/lib/stdlib --source-id ocaml-base-compiler/src/stdlib/camlinternalFormatBasics.ml
odoc compile ~/.opam/5.2.0/lib/re/re__.cmt --output-dir _odoc/ -I _odoc/ --enable-missing-root-warning --parent-id re/lib/re
odoc compile ~/.opam/5.2.0/lib/ocaml/camlinternalFormatBasics.cmti --output-dir _odoc/ -I _odoc/ --enable-missing-root-warning --parent-id ocaml-base-compiler/lib/stdlib
odoc compile-impl ~/.opam/5.2.0/lib/ocaml/stdlib.cmt --output-dir _odoc/ -I _odoc/ -I _odoc/ocaml-base-compiler/lib/stdlib/ --enable-missing-root-warning --parent-id ocaml-base-compiler/lib/stdlib --source-id ocaml-base-compiler/src/stdlib/stdlib.ml
odoc compile ~/.opam/5.2.0/lib/ocaml/stdlib.cmti --output-dir _odoc/ -I _odoc/ -I _odoc/ocaml-base-compiler/lib/stdlib/ --enable-missing-root-warning --parent-id ocaml-base-compiler/lib/stdlib
odoc compile-impl ~/.opam/5.2.0/lib/ocaml/stdlib__Int32.cmt --output-dir _odoc/ -I _odoc/ -I _odoc/ocaml-base-compiler/lib/stdlib/ --enable-missing-root-warning --parent-id ocaml-base-compiler/lib/stdlib --source-id ocaml-base-compiler/src/stdlib/int32.ml
odoc compile-impl ~/.opam/5.2.0/lib/ocaml/stdlib__Int.cmt --output-dir _odoc/ -I _odoc/ -I _odoc/ocaml-base-compiler/lib/stdlib/ --enable-missing-root-warning --parent-id ocaml-base-compiler/lib/stdlib --source-id ocaml-base-compiler/src/stdlib/int.ml
odoc compile-impl ~/.opam/5.2.0/lib/ocaml/stdlib__Either.cmt --output-dir _odoc/ -I _odoc/ -I _odoc/ocaml-base-compiler/lib/stdlib/ --enable-missing-root-warning --parent-id ocaml-base-compiler/lib/stdlib --source-id ocaml-base-compiler/src/stdlib/either.ml
odoc compile-impl ~/.opam/5.2.0/lib/ocaml/stdlib__Uchar.cmt --output-dir _odoc/ -I _odoc/ -I _odoc/ocaml-base-compiler/lib/stdlib/ --enable-missing-root-warning --parent-id ocaml-base-compiler/lib/stdlib --source-id ocaml-base-compiler/src/stdlib/uchar.ml
odoc compile-impl ~/.opam/5.2.0/lib/ocaml/stdlib__Domain.cmt --output-dir _odoc/ -I _odoc/ -I _odoc/ocaml-base-compiler/lib/stdlib/ --enable-missing-root-warning --parent-id ocaml-base-compiler/lib/stdlib --source-id ocaml-base-compiler/src/stdlib/domain.ml
odoc compile-impl ~/.opam/5.2.0/lib/ocaml/stdlib__Nativeint.cmt --output-dir _odoc/ -I _odoc/ -I _odoc/ocaml-base-compiler/lib/stdlib/ --enable-missing-root-warning --parent-id ocaml-base-compiler/lib/stdlib --source-id ocaml-base-compiler/src/stdlib/nativeint.ml
odoc compile-impl ~/.opam/5.2.0/lib/ocaml/stdlib__Unit.cmt --output-dir _odoc/ -I _odoc/ -I _odoc/ocaml-base-compiler/lib/stdlib/ --enable-missing-root-warning --parent-id ocaml-base-compiler/lib/stdlib --source-id ocaml-base-compiler/src/stdlib/unit.ml
odoc compile-impl ~/.opam/5.2.0/lib/tyxml/tyxml.cmt --output-dir _odoc/ -I _odoc/ -I _odoc/ocaml-base-compiler/lib/stdlib/ --enable-missing-root-warning --parent-id tyxml/lib/tyxml --source-id tyxml/src/tyxml/tyxml.ml
odoc compile-impl ~/.opam/5.2.0/lib/ocaml/camlinternalLazy.cmt --output-dir _odoc/ -I _odoc/ -I _odoc/ocaml-base-compiler/lib/stdlib/ --enable-missing-root-warning --parent-id ocaml-base-compiler/lib/stdlib --source-id ocaml-base-compiler/src/stdlib/camlinternalLazy.ml
odoc compile-impl ~/.opam/5.2.0/lib/tyxml/functor/xml_wrap.cmt --output-dir _odoc/ -I _odoc/ -I _odoc/ocaml-base-compiler/lib/stdlib/ --enable-missing-root-warning --parent-id tyxml/lib/tyxml.functor --source-id tyxml/src/tyxml.functor/xml_wrap.ml
odoc compile-impl ~/.opam/5.2.0/lib/ocaml/stdlib__Complex.cmt --output-dir _odoc/ -I _odoc/ -I _odoc/ocaml-base-compiler/lib/stdlib/ --enable-missing-root-warning --parent-id ocaml-base-compiler/lib/stdlib --source-id ocaml-base-compiler/src/stdlib/complex.ml
odoc compile-impl ~/.opam/5.2.0/lib/ocaml/stdlib__Int64.cmt --output-dir _odoc/ -I _odoc/ -I _odoc/ocaml-base-compiler/lib/stdlib/ --enable-missing-root-warning --parent-id ocaml-base-compiler/lib/stdlib --source-id ocaml-base-compiler/src/stdlib/int64.ml
odoc compile-impl ~/.opam/5.2.0/lib/ocaml/stdlib__Arg.cmt --output-dir _odoc/ -I _odoc/ -I _odoc/ocaml-base-compiler/lib/stdlib/ --enable-missing-root-warning --parent-id ocaml-base-compiler/lib/stdlib --source-id ocaml-base-compiler/src/stdlib/arg.ml
odoc compile-impl ~/.opam/5.2.0/lib/ocaml/stdlib__Sys.cmt --output-dir _odoc/ -I _odoc/ -I _odoc/ocaml-base-compiler/lib/stdlib/ --enable-missing-root-warning --parent-id ocaml-base-compiler/lib/stdlib --source-id ocaml-base-compiler/src/stdlib/sys.ml
odoc compile ~/.opam/5.2.0/lib/tyxml/functor/svg_types.cmti --output-dir _odoc/ -I _odoc/ -I _odoc/ocaml-base-compiler/lib/stdlib/ --enable-missing-root-warning --parent-id tyxml/lib/tyxml.functor
odoc compile-impl ~/.opam/5.2.0/lib/ocaml/stdlib__StdLabels.cmt --output-dir _odoc/ -I _odoc/ -I _odoc/ocaml-base-compiler/lib/stdlib/ --enable-missing-root-warning --parent-id ocaml-base-compiler/lib/stdlib --source-id ocaml-base-compiler/src/stdlib/stdLabels.ml
odoc compile-impl ~/.opam/5.2.0/lib/ocaml/stdlib__Fun.cmt --output-dir _odoc/ -I _odoc/ -I _odoc/ocaml-base-compiler/lib/stdlib/ --enable-missing-root-warning --parent-id ocaml-base-compiler/lib/stdlib --source-id ocaml-base-compiler/src/stdlib/fun.ml
odoc compile-impl ~/.opam/5.2.0/lib/ocaml/stdlib__Digest.cmt --output-dir _odoc/ -I _odoc/ -I _odoc/ocaml-base-compiler/lib/stdlib/ --enable-missing-root-warning --parent-id ocaml-base-compiler/lib/stdlib --source-id ocaml-base-compiler/src/stdlib/digest.ml
odoc compile-impl ~/.opam/5.2.0/lib/ocaml/stdlib__Atomic.cmt --output-dir _odoc/ -I _odoc/ -I _odoc/ocaml-base-compiler/lib/stdlib/ --enable-missing-root-warning --parent-id ocaml-base-compiler/lib/stdlib --source-id ocaml-base-compiler/src/stdlib/atomic.ml
odoc compile-impl ~/.opam/5.2.0/lib/ocaml/stdlib__Type.cmt --output-dir _odoc/ -I _odoc/ -I _odoc/ocaml-base-compiler/lib/stdlib/ --enable-missing-root-warning --parent-id ocaml-base-compiler/lib/stdlib --source-id ocaml-base-compiler/src/stdlib/type.ml
odoc compile-impl ~/.opam/5.2.0/lib/ocaml/stdlib__Semaphore.cmt --output-dir _odoc/ -I _odoc/ -I _odoc/ocaml-base-compiler/lib/stdlib/ --enable-missing-root-warning --parent-id ocaml-base-compiler/lib/stdlib --source-id ocaml-base-compiler/src/stdlib/semaphore.ml
odoc compile-impl ~/.opam/5.2.0/lib/ocaml/stdlib__Bool.cmt --output-dir _odoc/ -I _odoc/ -I _odoc/ocaml-base-compiler/lib/stdlib/ --enable-missing-root-warning --parent-id ocaml-base-compiler/lib/stdlib --source-id ocaml-base-compiler/src/stdlib/bool.ml
odoc compile-impl ~/.opam/5.2.0/lib/ocaml/stdlib__Callback.cmt --output-dir _odoc/ -I _odoc/ -I _odoc/ocaml-base-compiler/lib/stdlib/ --enable-missing-root-warning --parent-id ocaml-base-compiler/lib/stdlib --source-id ocaml-base-compiler/src/stdlib/callback.ml
odoc compile-impl ~/.opam/5.2.0/lib/ocaml/stdlib__Mutex.cmt --output-dir _odoc/ -I _odoc/ -I _odoc/ocaml-base-compiler/lib/stdlib/ --enable-missing-root-warning --parent-id ocaml-base-compiler/lib/stdlib --source-id ocaml-base-compiler/src/stdlib/mutex.ml
odoc compile-impl ~/.opam/5.2.0/lib/ocaml/stdlib__Char.cmt --output-dir _odoc/ -I _odoc/ -I _odoc/ocaml-base-compiler/lib/stdlib/ --enable-missing-root-warning --parent-id ocaml-base-compiler/lib/stdlib --source-id ocaml-base-compiler/src/stdlib/char.ml
odoc compile-impl ~/.opam/5.2.0/lib/ocaml/stdlib__Lexing.cmt --output-dir _odoc/ -I _odoc/ -I _odoc/ocaml-base-compiler/lib/stdlib/ --enable-missing-root-warning --parent-id ocaml-base-compiler/lib/stdlib --source-id ocaml-base-compiler/src/stdlib/lexing.ml
odoc compile-impl ~/.opam/5.2.0/lib/ocaml/stdlib__Filename.cmt --output-dir _odoc/ -I _odoc/ -I _odoc/ocaml-base-compiler/lib/stdlib/ --enable-missing-root-warning --parent-id ocaml-base-compiler/lib/stdlib --source-id ocaml-base-compiler/src/stdlib/filename.ml
odoc compile ~/.opam/5.2.0/lib/ocaml/camlinternalLazy.cmti --output-dir _odoc/ -I _odoc/ -I _odoc/ocaml-base-compiler/lib/stdlib/ --enable-missing-root-warning --parent-id ocaml-base-compiler/lib/stdlib
odoc compile ~/.opam/5.2.0/lib/ocaml/stdlib__Domain.cmti --output-dir _odoc/ -I _odoc/ -I _odoc/ocaml-base-compiler/lib/stdlib/ --enable-missing-root-warning --parent-id ocaml-base-compiler/lib/stdlib
odoc compile ~/.opam/5.2.0/lib/ocaml/stdlib__Int.cmti --output-dir _odoc/ -I _odoc/ -I _odoc/ocaml-base-compiler/lib/stdlib/ --enable-missing-root-warning --parent-id ocaml-base-compiler/lib/stdlib
odoc compile ~/.opam/5.2.0/lib/ocaml/stdlib__Uchar.cmti --output-dir _odoc/ -I _odoc/ -I _odoc/ocaml-base-compiler/lib/stdlib/ --enable-missing-root-warning --parent-id ocaml-base-compiler/lib/stdlib
odoc compile ~/.opam/5.2.0/lib/ocaml/stdlib__Either.cmti --output-dir _odoc/ -I _odoc/ -I _odoc/ocaml-base-compiler/lib/stdlib/ --enable-missing-root-warning --parent-id ocaml-base-compiler/lib/stdlib
odoc compile ~/.opam/5.2.0/lib/ocaml/stdlib__Int32.cmti --output-dir _odoc/ -I _odoc/ -I _odoc/ocaml-base-compi
Pipeline: from .cmti to HTML
Compile phase: .cmti to .odoc
- Creates an internal representation of the interface
Link phase: .odoc to .odocl
- "Forward "reference example:
val default : t (** Default value. Used in {!Module.bar}. *)
Document generation: .odocl to HTML/Latex/Manpage
- What about pages? Medias?
- What about cross-packages references?
- What about ocaml.org vs dune vs odig?
- What about incremental compilations?
Odoc 3: Toward a full documentation generator
Many features have been added to odoc lately, but there was one problem:
- What about ocaml.org vs dune vs odig? DRIVERS!
ACT I: Decide strong conventions on how a package should be built!
ACT II: Decide on a CLI nicer with drivers!
ACT III: Implement render source code, sidebar, cross-package references