Skip to content

doc: link Eliom with an odoc reference instead of a hardcoded URL #360

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
balat merged 1 commit into from
Jun 20, 2026
Merged

doc: link Eliom with an odoc reference instead of a hardcoded URL #360

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions doc/wodoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,9 @@
(link "JSX syntax" tyxml/jsx.html jsx))
(section "TyXML - API"
(link "API reference" tyxml/api.html api)))

;; Sibling Ocsigen projects this doc links to, so wodoc rewrites their
;; ocaml.org cross-references to relative links into their deployed docs.
;; (pkg deploy-dir layout wrapper-module)
(hosted
(eliom eliom true Eliom))
4 changes: 2 additions & 2 deletions docs/index.mld
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ To use TyXML in standalone manner, simply install the [tyxml] OPAM package, link
{2 Use with another library}

TyXML combinators can be used in conjunction with other libraries. Please consult the relevant document. For example,
{{:https://ocsigen.org/eliom/latest/clientserver-html.html}Eliom}
{{!/eliom/page-clientserver-html}Eliom}
and
{{!Js_of_ocaml_tyxml.Tyxml_js}Js_of_ocaml}.

Expand Down Expand Up @@ -128,7 +128,7 @@ let mypage =
(body [mycontent])
]}

If you are using {{:https://ocsigen.org/eliom/latest/clientserver-html.html}Eliom}
If you are using {{!/eliom/page-clientserver-html}Eliom}
or {{!Js_of_ocaml_tyxml.Tyxml_js}Js_of_ocaml},
this is the end of TyXML's territory. However, for standalone use, we now need to print our document as an HTML file. The standalone implementation comes with a printer, {!Tyxml.Html.pp}, that we can use to print files:

Expand Down
Loading