this repo has no description
odoc html-generate: add --mode-links URI argument
Passes a base URI to the HTML renderer for linking mode and jkind
names to external documentation. Fragment is the name as rendered.
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
+12
-3
+12
-3
odoc/src/odoc/bin/main.ml
+12
-3
odoc/src/odoc/bin/main.ml
···
1310
1310
let doc = "File containing remap rules." in
1311
1311
Arg.(value & opt (some file) None & info ~docv:"FILE" ~doc [ "remap-file" ])
1312
1312
1313
+
let mode_links =
1314
+
let doc =
1315
+
"Base URI for mode and jkind documentation links. Mode and jkind \
1316
+
names become the URI fragment, e.g. $(b,--mode-links \
1317
+
https://example.com/modes) makes $(i,local) link to \
1318
+
$(i,https://example.com/modes#local)."
1319
+
in
1320
+
Arg.(value & opt (some string) None & info [ "mode-links" ] ~docv:"URI" ~doc)
1321
+
1313
1322
let extra_args =
1314
1323
let config semantic_uris closed_details indent theme_uri support_uri
1315
1324
search_uris extra_css flat as_json shell remap remap_file
1316
-
home_breadcrumb =
1325
+
home_breadcrumb mode_links =
1317
1326
let open_details = not closed_details in
1318
1327
let remap =
1319
1328
match remap_file with
···
1329
1338
let html_config =
1330
1339
Odoc_html.Config.v ~theme_uri ~support_uri ~search_uris ~extra_css
1331
1340
~semantic_uris ~indent ~flat ~open_details ~as_json ?shell ~remap
1332
-
?home_breadcrumb ()
1341
+
?home_breadcrumb ?mode_links ()
1333
1342
in
1334
1343
{ Html_page.html_config }
1335
1344
in
1336
1345
Term.(
1337
1346
const config $ semantic_uris $ closed_details $ indent $ theme_uri
1338
1347
$ support_uri $ search_uri $ extra_css $ flat $ as_json $ shell $ remap
1339
-
$ remap_file $ home_breadcrumb)
1348
+
$ remap_file $ home_breadcrumb $ mode_links)
1340
1349
end
1341
1350
1342
1351
module Odoc_html = Make_renderer (Odoc_html_args)