Module `Dot_extension`Source

Graphviz/DOT diagram extension for odoc.

Renders {@dot[...]} code blocks as diagrams. By default uses client-side JavaScript (Viz.js), but can render server-side to PNG/SVG with format option.

Example:

  {@dot layout=neato[
    digraph G {
      a -> b -> c;
      b -> d;
    }

Sourcemodule Api = Odoc_extension_api

Sourcemodule Block = Api.Block

Sourcemodule Inline = Api.Inline

Sourceval viz_js_url : string

The Viz.js library URL for client-side rendering

Sourceval viz_full_js_url : string

Sourceval diagram_counter : int Stdlib.ref

Generate a unique ID for each diagram

Sourceval fresh_id : unit -> string

Source

val get_layout : 
  [< `Binding of
       string Odoc_parser.Loc.with_location
       * string Odoc_parser.Loc.with_location
  | `Tag of 'a ]
    list ->
  string

Extract option values

Source

val get_format : 
  [< `Binding of
       string Odoc_parser.Loc.with_location * 'a Odoc_parser.Loc.with_location
  | `Tag of 'b ]
    list ->
  'a option

Source

val get_filename : 
  [< `Binding of
       string Odoc_parser.Loc.with_location * 'a Odoc_parser.Loc.with_location
  | `Tag of 'b ]
    list ->
  'a option

Source

val get_dimensions : 
  [< `Binding of
       string Odoc_parser.Loc.with_location * 'a Odoc_parser.Loc.with_location & 
       string Odoc_parser.Loc.with_location
       * 'b Odoc_parser.Loc.with_location
  | `Tag of 'c & 'd ]
    list ->
  'b option * 'a option

Sourceval has_graph_wrapper : string -> bool

Check if content looks like a complete DOT graph

Sourceval ensure_graph_wrapper : string -> string

Wrap content in a digraph if needed

Sourceval make_style : string option -> string option -> string

Build inline style string from dimensions

Source

val run_dot : 
  layout:string ->
  format:string ->
  string ->
  (bytes, string) Stdlib.result

Run the dot command to render to a specific format

Sourceval dot_init_js : string

Runtime JS for dot — follows the MutationObserver pattern so diagrams render on both direct load and SPA navigation. DOT source and layout engine are stored in data attributes on the container div.

Sourcemodule Dot_handler : Api.Code_Block_Extension

Sourceval dot_css : string

CSS for dot diagrams

Sourceval extension_info : Api.extension_info

Extension documentation

Module Dot_extensionSource

Module `Dot_extension`Source