Driver: generate "external" pages #1183
Conversation
panglesd
added
the
no changelog
|
(Hopefully, this can be made less clicky by having the landing page of a package be better (similar to odig's one / ocaml.org's one), but it's nice that library list and library landing page exists to avoid 404 pages eg on handcrafted path) |
src/html/link.ml
Outdated
| let url_segs = for_linking ~is_flat url in | ||
| let filename = | ||
| match url_segs with | ||
| | [] -> Fpath.v "./" |
There was a problem hiding this comment.
What was the goal of this ? for_linking is defined just above and never returns an empty list.
There was a problem hiding this comment.
Strange, likely a leftover from some modifications that required that (maybe when the parent id was empty?).
I removed it.
src/driver/landing_pages.ml
Outdated
| @@ -0,0 +1,137 @@ | |||
| open Packages | |||
| open Odoc_unit | |||
| let write_file file content = Bos.OS.File.write file content |> Result.get_ok | |||
There was a problem hiding this comment.
This fails because file might be in a directory that do not exists:
| let write_file file content = Bos.OS.File.write file content |> Result.get_ok | |
| let write_file file content = | |
| Bos.OS.Dir.create (Fpath.parent file) |> Result.get_ok |> ignore; | |
| Bos.OS.File.write file content |> Result.get_ok |
There was a problem hiding this comment.
Thanks! I'll use the already written "Util.write_file instead, which does the folder creation.
|
I think it'd be useful to have some tests for the changed functionality in odoc itself. |
src/driver/landing_pages.ml
Outdated
| } | ||
|
|
||
| module PackageLanding = struct | ||
| let content pkg = |
There was a problem hiding this comment.
I've refactored the content functions to take advantage of Format in panglesd#32
panglesd
force-pushed
the
odoc3-external-pages
branch
from
3f244a8
to
046bed9
Compare
Generate pages that are external of a package: landing pages for package, library, library list and package list. There is a problem currently with empty parent id. Currently using a "`a`" container directory for the package list.
Useful for the list of packages landing page
Util.write_file is refactored to be more suitable. Co-authored-by: Paul-Elliot <[email protected]>
Co-authored-by: Jules Aguillon <[email protected]>
panglesd
force-pushed
the
odoc3-external-pages
branch
from
046bed9
to
5faa896
Compare
|
Rebased! |
This adds generation of (basic) pages for:
<pkgname>/folder)<pkgname>/lib/folder)<pkgname>/lib/<libname>folder)This PR does not touch only the driver: I had to add the possibility of an empty
--parent-idfor the "list of all packages" page.I also had to avoid "relative references" in the generated pages as they are did not resolve. I used `rooted absolute references instead, and I will investigate the bug.
This will hopefully be useful to test various ideas for the breadcrumbs.