From 716602a81f7cc46b3c0df9b74dbbb296ec34684b Mon Sep 17 00:00:00 2001 From: Jon Ludlam Date: Tue, 12 Mar 2024 14:31:20 +0000 Subject: [PATCH 1/2] Add canonical tags to a few types so odoc knows where to find them Currently the docs are either missing tags where they contain hidden items or linking to hidden modules. See ocaml/odoc#1091 --- src/ast_block.ml | 5 +++++ src/ast_inline.ml | 2 ++ 2 files changed, 7 insertions(+) diff --git a/src/ast_block.ml b/src/ast_block.ml index 3ca545d9..5d4ec38a 100644 --- a/src/ast_block.ml +++ b/src/ast_block.ml @@ -11,16 +11,21 @@ module InlineContent = struct end module List_types = struct + + (** @canonical Omd.list_type *) type list_type = | Ordered of int * char | Bullet of char + (** @canonical Omd.list_spacing *) type list_spacing = | Loose | Tight end module Table_alignments = struct + + (** @canonical Omd.cell_alignment *) type cell_alignment = | Default | Left diff --git a/src/ast_inline.ml b/src/ast_inline.ml index a74c8de9..a5122f7f 100644 --- a/src/ast_inline.ml +++ b/src/ast_inline.ml @@ -5,6 +5,8 @@ those somehow? Or should we include these in the document model, but but with the caveat that most renderings of the document don't support attributes in these nodes? *) + +(** @canonical Omd.inline *) type 'attr inline = | Concat of 'attr * 'attr inline list | Text of 'attr * string From 2f547ddfbc897506ecd54fd8a8080cf5f03b1ea5 Mon Sep 17 00:00:00 2001 From: Shon Feder Date: Sat, 16 Mar 2024 12:39:05 -0400 Subject: [PATCH 2/2] Fix formatting --- src/ast_block.ml | 2 -- 1 file changed, 2 deletions(-) diff --git a/src/ast_block.ml b/src/ast_block.ml index 5d4ec38a..29485fa7 100644 --- a/src/ast_block.ml +++ b/src/ast_block.ml @@ -11,7 +11,6 @@ module InlineContent = struct end module List_types = struct - (** @canonical Omd.list_type *) type list_type = | Ordered of int * char @@ -24,7 +23,6 @@ module List_types = struct end module Table_alignments = struct - (** @canonical Omd.cell_alignment *) type cell_alignment = | Default