Allow linking of source trees

Currently, there is nothing to resolve, so this pass is not useful. However,
drivers should continue to link all pages, as it is easier, and if we later
introduce features that need linking, everything will be ready on the driver
side.

Signed-off-by: Paul-Elliot <[email protected]>

Author: panglesd

src/odoc/odoc_link.ml

@@ -32,8 +32,9 @@ let from_odoc ~resolver ~warnings_options input output =
   Odoc_file.load input >>= fun unit ->
   let input_warnings = unit.Odoc_file.warnings in
   match unit.content with
-  | Source_tree_content _ ->
-      Error (`Msg "Source tree pages do not need to be linked.")
+  | Source_tree_content st ->
+      Odoc_file.save_source_tree output ~warnings:[] st;
+      Ok (`Source_tree st)
   | Page_content page ->
       link_page ~resolver ~filename page
       |> handle_warnings ~input_warnings ~warnings_options

src/odoc/rendering.ml

@@ -26,6 +26,7 @@ let documents_of_input ~renderer ~extra ~resolver ~warnings_options ~syntax
     input =
   let output = Fs.File.(set_ext ".odocl" input) in
   Odoc_link.from_odoc ~resolver ~warnings_options input output >>= function
+  | `Source_tree st -> Ok (Renderer.documents_of_source_tree ~syntax st)
   | `Page page -> Ok [ Renderer.document_of_page ~syntax page ]
   | `Module m -> documents_of_unit ~warnings_options ~syntax ~renderer ~extra m
 

test/sources/source_hierarchy.t/run.t

@@ -20,8 +20,9 @@ Now, compile the pages with the --source option. The source-name must be include
   $ odoc link -I . a.odoc
   $ odoc link -I . b.odoc
   $ odoc link -I . c.odoc
+  $ odoc link -I . src-source.odoc
   $ odoc html-generate --indent -o html page-root.odocl
-  $ odoc html-generate --indent -o html src-source.odoc
+  $ odoc html-generate --indent -o html src-source.odocl
   $ odoc html-generate --source a.ml --indent -o html a.odocl
   $ odoc html-generate --source b.ml --indent -o html b.odocl
   $ odoc html-generate --source c.ml --indent -o html c.odocl