Skip to content

Commit

Permalink
Add canonical tags to a few types so odoc knows where to find them
Browse files Browse the repository at this point in the history
Currently the docs are either missing tags where they contain hidden
items or linking to hidden modules. See ocaml/odoc#1091
  • Loading branch information
jonludlam committed Mar 12, 2024
1 parent 373e3f8 commit 716602a
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 0 deletions.
5 changes: 5 additions & 0 deletions src/ast_block.ml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 2 additions & 0 deletions src/ast_inline.ml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 716602a

Please sign in to comment.