Render source code along side documentation

.github/workflows/build.yml

@@ -15,7 +15,7 @@ jobs:
           # - windows-latest Windows doesn't work yet
         ocaml-compiler:
           # Don't include every versions. OCaml-CI already covers that
-          - 4.12.x
+          - 4.14.x
         include:
           - os: ubuntu-latest # Enable coverage only on a single build
             send-coverage: true

.ocamlformat-ignore

@@ -1,10 +1,15 @@
 src/document/*.cppo.ml
+src/loader/*.cppo.ml
 src/loader/cmi.ml
 src/loader/cmi.mli
 src/loader/cmt.ml
 src/loader/cmti.ml
 src/loader/doc_attr.ml
-src/loader/*.cppo.ml
+src/loader/local_jmp.ml
+src/loader/lookup_def.ml
+src/loader/uid.ml
+src/loader/uid.mli
+src/syntax_highlighter/syntax_highlighter.ml
 src/model/*.cppo.ml
 src/html_support_files/*.ml
 test/xref2/lib/*

CHANGES.md

@@ -1,3 +1,9 @@
+UNRELEASED
+----------
+
+Additions
+- Source code rendering (@Julow, @panglesd, #909)
+
 2.2.0
 -----
 

doc/library_mlds/odoc_html_support_files.mld

@@ -0,0 +1,3 @@
+{0 odoc_html_support_files}
+
+{!childmodule-Odoc_html_support_files}

doc/library_mlds/stdlib.mld

@@ -6,7 +6,6 @@
 {!module-Annot}
 {!module-Arch}
 {!module-Arg_helper}
-{!module-Arith_status}
 {!module-Asmgen}
 {!module-Asmlibrarian}
 {!module-Asmlink}
@@ -18,10 +17,8 @@
 {!module-Asttypes}
 {!module-Attr_helper}
 {!module-Augment_specialised_args}
-{!module-Available_regs}
 {!module-Backend_intf}
 {!module-Backend_var}
-{!module-Big_int}
 {!module-Bigarray}
 {!module-Branch_relaxation}
 {!module-Branch_relaxation_intf}
@@ -72,8 +69,6 @@
 {!module-Compile_common}
 {!module-Compilenv}
 {!module-Compmisc}
-{!module-Compute_ranges}
-{!module-Compute_ranges_intf}
 {!module-Condition}
 {!module-Config}
 {!module-Consistbl}
@@ -155,8 +150,6 @@
 {!module-Mtype}
 {!module-Mutable_variable}
 {!module-Mutex}
-{!module-Nat}
-{!module-Num}
 {!module-Numbers}
 {!module-Opcodes}
 {!module-Oprint}
@@ -191,12 +184,9 @@
 {!module-Profile}
 {!module-Profiling}
 {!module-Projection}
-{!module-Ratio}
 {!module-Rec_check}
 {!module-Ref_to_variables}
 {!module-Reg}
-{!module-Reg_availability_set}
-{!module-Reg_with_debug_info}
 {!module-Reload}
 {!module-Reloadgen}
 {!module-Remove_free_vars_equal_to_args}
@@ -238,7 +228,6 @@
 {!module-Tast_mapper}
 {!module-Terminfo}
 {!module-Thread}
-{!module-ThreadUnix}
 {!module-Topdirs}
 {!module-Toploop}
 {!module-Topmain}

doc/library_mlds/yojson.mld

@@ -1,5 +1,4 @@
 {0 Yojson}
 
 {!module-Yojson}
-{!module-Yojson_biniou}
 

src/compat/compatcmdliner.ml

@@ -61,6 +61,10 @@ module Arg = struct
   let bool = bool
 
   let ( & ) = ( & )
+
+  let conv = conv
+  let conv_parser = conv_parser
+  let conv_printer = conv_printer
 end
 
 [@@@ocaml.warning "+3"]

src/document/ML.mli

@@ -14,7 +14,18 @@
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  *)
 
-val compilation_unit : Odoc_model.Lang.Compilation_unit.t -> Types.Page.t
+open Odoc_model
+open Odoc_model.Paths
 
-val page : Odoc_model.Lang.Page.t -> Types.Page.t
+val compilation_unit : Lang.Compilation_unit.t -> Types.Document.t
+
+val page : Lang.Page.t -> Types.Document.t
 (** Convert compilation unit or page models into a document *)
+
+val source_tree : Lang.SourceTree.t -> Types.Document.t list
+
+val source_page :
+  Identifier.SourcePage.t ->
+  Lang.Source_info.infos ->
+  string ->
+  Types.Document.t

src/document/comment.ml

@@ -309,7 +309,8 @@ let heading
   let title = non_link_inline_element_list text in
   let level = heading_level_to_int attrs.Comment.heading_level in
   let label = Some label in
-  Item.Heading { label; level; title }
+  let source_anchor = None in
+  Item.Heading { label; level; title; source_anchor }
 
 let item_element : Comment.block_element -> Item.t list = function
   | #Comment.attached_block_element as e ->

src/document/doctree.ml

@@ -62,7 +62,7 @@ end = struct
     | Include { content = { status; content; _ }; _ } ->
         if on_sub status then Rec content else Skip
     | Heading { label = None; _ } -> Skip
-    | Heading { label = Some label; level; title } ->
+    | Heading { label = Some label; level; title; _ } ->
         Heading ((label, title), level)
 
   let node mkurl (anchor, text) children =
@@ -150,9 +150,9 @@ module Shift = struct
   and walk_item ~on_sub shift_state (l : Item.t list) =
     match l with
     | [] -> []
-    | Heading { label; level; title } :: rest ->
+    | Heading { label; level; title; source_anchor } :: rest ->
         let shift_state, level = shift shift_state level in
-        Item.Heading { label; level; title }
+        Item.Heading { label; level; title; source_anchor }
         :: walk_item ~on_sub shift_state rest
     | Include subp :: rest ->
         let content = include_ ~on_sub shift_state subp.content in
@@ -291,12 +291,13 @@ end = struct
 end
 
 module PageTitle : sig
-  val render_title : Page.t -> Item.t list
+  val render_title : ?source_anchor:Url.t -> Page.t -> Item.t list
+  val render_src_title : Source_page.t -> Item.t list
 end = struct
-  let format_title kind name =
+  let format_title ~source_anchor kind name =
     let mk title =
       let level = 0 and label = None in
-      [ Types.Item.Heading { level; label; title } ]
+      [ Types.Item.Heading { level; label; title; source_anchor } ]
     in
     let prefix s =
       mk (Types.inline (Text (s ^ " ")) :: Codefmt.code (Codefmt.txt name))
@@ -307,15 +308,19 @@ end = struct
     | `ModuleType -> prefix "Module type"
     | `ClassType -> prefix "Class type"
     | `Class -> prefix "Class"
+    | `SourcePage -> prefix "Source file"
     | `Page | `LeafPage | `File -> []
 
   let make_name_from_path { Url.Path.name; parent; _ } =
     match parent with
     | None | Some { kind = `Page; _ } -> name
     | Some p -> Printf.sprintf "%s.%s" p.name name
 
-  let render_title (p : Page.t) =
-    format_title p.url.kind (make_name_from_path p.url)
+  let render_title ?source_anchor (p : Page.t) =
+    format_title ~source_anchor p.url.kind (make_name_from_path p.url)
+
+  let render_src_title (p : Source_page.t) =
+    format_title ~source_anchor:None p.url.kind (make_name_from_path p.url)
 end
 
 module Math : sig

src/document/dune

@@ -12,4 +12,4 @@
  (public_name odoc.document)
  (instrumentation
   (backend bisect_ppx))
- (libraries odoc_model fpath))
+ (libraries odoc_model fpath astring))