diff --git a/test/html/cases/markup.mli b/test/html/cases/markup.mli index e9e0209f74..7df7a27ecc 100644 --- a/test/html/cases/markup.mli +++ b/test/html/cases/markup.mli @@ -66,14 +66,16 @@ {2 Preformatted text} This is a code block: -{[ -let foo = () -(** There are some nested comments in here, but an unpaired comment - terminator would terminate the whole doc surrounding comment. It's - best to keep code blocks no wider than 72 characters. *) -]} - - We still need to add syntax highlighting. That should be its own test. + + {[ + let foo = () + (** There are some nested comments in here, but an unpaired comment + terminator would terminate the whole doc surrounding comment. It's + best to keep code blocks no wider than 72 characters. *) + + let bar = + ignore foo + ]} There are also verbatim blocks: diff --git a/test/html/expect/markup.html b/test/html/expect/markup.html index 3c92dac49d..fe84c55ed2 100644 --- a/test/html/expect/markup.html +++ b/test/html/expect/markup.html @@ -2,7 +2,10 @@ Markup (test_package.Markup)

Module Markup

Here, we test the rendering of comment markup.

Sections

Let's get these done first, because sections will be used to break up the rest of this test.

Besides the section heading above, there are also

Subsection headings

and

Sub-subsection headings

but odoc has banned deeper headings. There are also title headings, but they are only allowed in mld files.

Anchors

Sections can have attached Anchors, and it is possible to link to them. Links to section headers should not be set in source code style.

Styling

This paragraph has some styled elements: bold and italic, bold italic, emphasis, emphasis within emphasis, bold italic, superscript, subscript. The line spacing should be enough for superscripts and subscripts not to look odd.

code is a different kind of markup that doesn't allow nested markup.

It's possible for two markup elements to appear next to each other and have a space, and appear nextto each other with no space. It doesn't matter how much space it was in the source: in this sentence, it was two space characters. And in this one, there is a newline.

Code can appear inside other markup. Its display shouldn't be affected.

This is a link. It sends you to the top of this page. Links can have markup inside them: bold, italics, emphasis, superscript, subscript, and code. Links can also be nested inside markup. Links cannot be nested inside each other. This link has no replacement text: #. The text is filled in by odoc. This is a shorthand link: #. The text is also filled in by odoc in this case.

This is a reference to foo. References can have replacement text: the value foo. Except for the special lookup support, references are pretty much just like links. The replacement text can have nested styles: bold, italic, emphasis, superscript, subscript, and code. It's also possible to surround a reference in a style: foo. References can't be nested inside references, and links and references can't be nested inside each other.

Preformatted text

This is a code block:

let foo = ()
 (** There are some nested comments in here, but an unpaired comment
     terminator would terminate the whole doc surrounding comment. It's
-    best to keep code blocks no wider than 72 characters. *)

We still need to add syntax highlighting. That should be its own test.

There are also verbatim blocks:

The main difference is these don't get syntax highlighting.

Lists

  1. This is a
  2. shorthand numbered list.

just creates a paragraph outside the list.

  1. but there is also the numbered variant.

Unicode

The parser supports any ASCII-compatible encoding, in particuλar UTF-8.

Raw HTML

Raw HTML can be as inline elements into sentences.

+ best to keep code blocks no wider than 72 characters. *) + +let bar = + ignore foo

There are also verbatim blocks:

The main difference is these don't get syntax highlighting.

Lists

  1. This is a
  2. shorthand numbered list.

just creates a paragraph outside the list.

  1. but there is also the numbered variant.

Unicode

The parser supports any ASCII-compatible encoding, in particuλar UTF-8.

Raw HTML

Raw HTML can be as inline elements into sentences.

If the raw HTML is the only thing in a paragraph, it is treated as a block element, and won't be wrapped in paragraph tags by the HTML generator.