Add source pages to docs

Author: panglesd

asset/css/doc.css

@@ -325,6 +325,15 @@ div.odoc .comment-delim {
   border-color: rgb(32, 68, 165);
 }
 
+.navmap-tag.source-tag::after {
+  content: "S";
+}
+.source-tag{
+  color: rgb(97, 8, 138);
+  background-color: rgb(97, 8, 138);
+  border-color: rgb(97, 8, 138);
+}
+
 span.icon-expand > .navmap-tag,
 span.no-expand > .navmap-tag {
   color: white;
@@ -372,3 +381,34 @@ span.sign-expand.open::before {
 /* Lists of modules */
 
 .modules { list-style-type: none; padding-left:0; }
+
+/* Source links float inside preformated text or headings. */
+a.source_link {
+  float: right;
+  color: var(--source-link-color);
+  font-family: "Fira Sans", sans-serif;
+  font-size: initial;
+}
+
+
+.source_container {
+  display: flex;
+}
+
+.source_line_column {
+  padding-right: 0.5em;
+  text-align: right;
+  color: var(--source-line-column);
+  background: var(--source-line-column-bg);
+}
+
+.source_line {
+  padding: 0 1em;
+}
+
+.source_code {
+  flex-grow: 1;
+  background: var(--code-background);
+  padding: 0 0.3em;
+  color: var(--code-color);
+}

src/ocamlorg_frontend/components/navmap.eml

@@ -8,6 +8,7 @@ type kind =
   | Class
   | Class_type
   | File
+  | Source
 
 type toc = {
   title : string;
@@ -26,6 +27,7 @@ let kind_title = function
   | Parameter -> "Parameter"
   | Class -> "Class"
   | Class_type -> "Class type"
+  | Source -> "Source"
   | _ -> "?"
 
 let title_style = "flex-1 flex-nowrap py-1 md:py-0.5 pr-1 text-title dark:text-dark-title truncate"
@@ -40,6 +42,7 @@ let icon_style = function
   | Parameter -> "navmap-tag parameter-tag"
   | Class -> "navmap-tag class-tag"
   | Class_type -> "navmap-tag class-type-tag"
+  | Source -> "navmap-tag source-tag"
   | _ -> "navmap-tag"
 
 let rec nested_render ~path (item : toc) =
@@ -135,6 +138,7 @@ let render
     <span class="<%s icon_style Module_type %>" style="display:inline-block;color:white"></span>Module type<br>
     <span class="<%s icon_style Parameter %>" style="display:inline-block;color:white"></span>Parameter<br>
     <span class="<%s icon_style Class %>" style="display:inline-block;color:white"></span>Class<br>
-    <span class="<%s icon_style Class_type %>" style="display:inline-block;color:white"></span>Class type
+    <span class="<%s icon_style Class_type %>" style="display:inline-block;color:white"></span>Class type<br>
+    <span class="<%s icon_style Source %>" style="display:inline-block;color:white"></span>Source
     </div>
   <% ); %>

src/ocamlorg_package/lib/ocamlorg_package.ml

@@ -241,6 +241,7 @@ module Documentation = struct
     | Class
     | ClassType
     | File
+    | Source
 
   let breadcrumb_kind_from_string s =
     match s with
@@ -251,6 +252,7 @@ module Documentation = struct
     | "class" -> Class
     | "class-type" -> ClassType
     | "file" -> File
+    | "source" -> Source
     | _ ->
         if String.starts_with ~prefix:"argument-" s then
           let i = List.hd (List.tl (String.split_on_char '-' s)) in
@@ -311,6 +313,17 @@ module Documentation = struct
           toc = List.map toc_of_json json_toc;
           content = header ^ preamble ^ content;
         }
+    | `Assoc
+        [
+          ("type", `String "source");
+          ("breadcrumbs", `List json_breadcrumbs);
+          ("global_toc", _);
+          ("header", `String header);
+          ("content", `String content);
+        ] ->
+        let breadcrumbs = List.map breadcrumb_from_json json_breadcrumbs in
+        let content = header ^ content in
+        { uses_katex = false; breadcrumbs; toc = []; content }
     | _ -> raise (Invalid_argument "malformed .html.json file")
 end
 

src/ocamlorg_package/lib/ocamlorg_package.mli

@@ -80,6 +80,7 @@ module Documentation : sig
     | Class
     | ClassType
     | File
+    | Source
 
   type breadcrumb = {
     name : string;

src/ocamlorg_web/lib/handler.ml

@@ -1271,6 +1271,7 @@ let package_documentation t kind req =
               | Some "class" -> Class
               | Some "class-type" -> Class_type
               | Some "file" -> File
+              | Some "source" -> Source
               | None -> Page
               | _ -> File);
             href = map_url sidebar.node.url;
@@ -1301,7 +1302,7 @@ let package_documentation t kind req =
           | Parameter i -> Parameter (b, i)
           | Class -> Class b
           | ClassType -> ClassType b
-          | Page | LeafPage | File -> Page b
+          | Page | LeafPage | File | Source -> Page b
         in
 
         Ocamlorg_frontend.Package_breadcrumbs.Documentation