Document doc-json

ocaml · Jul 18, 2023 · d8d6a31 · d8d6a31
1 parent 187b597
commit d8d6a31
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 2 deletions.
diff --git a/doc/reference/aliases.rst b/doc/reference/aliases.rst
@@ -105,7 +105,14 @@ used instead. For example, if the following is present in ``tests/dune``,
 @doc
 ^^^^
 
-This alias builds documentation for public libraries.
+This alias builds documentation for public libraries as HTML pages.
+
+@doc-json
+^^^^^^^^^
+
+This alias builds documentation for public libraries as JSON files. These are
+produced by ``odoc``'s option ``--as-json`` and can be consumed by external
+tools.
 
 @doc-private
 ^^^^^^^^^^^^

diff --git a/src/dune_engine/alias.ml b/src/dune_engine/alias.ml
@@ -107,7 +107,6 @@ let install = make_standard Name.install
 
 let doc = make_standard (Name.of_string "doc")
 
-(** XXX is there anything to do to make a new standard alias? document it? *)
 let doc_json = make_standard (Name.of_string "doc-json")
 
 let private_doc = make_standard (Name.of_string "doc-private")