Further voodoo #1252
Merged
Further voodoo #1252
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jonludlam
added
the
no changelog
jonludlam
force-pushed
the
further-voodoo
branch
from
5b24ad1 to
5ef2f8a
Compare
jonludlam
force-pushed
the
further-voodoo
branch
6 times, most recently
from
2d69c2c to
0114e3f
Compare
Julow
approved these changes
Dec 18, 2024
Comment on lines
+283
to
+285
| Odoc.sidebar_generate | ||
| ~output_file:Fpath.(output_dir // pkg_dir / "sidebar.json") | ||
| ~json:true index.output_file (); |
There was a problem hiding this comment.
Where is this json file used ? I find this code a bit brittle because if this file is ever needed somewhere else, nothing will ensure that it continues to be generated.
Any way the caller could set json = true ?
There was a problem hiding this comment.
It's used by ocaml.org - this is the sidebar json that served up for the per-package sidebar. The ocaml.org server reads this and renders its own sidebar.
| @@ -222,6 +179,8 @@ let process_package pkg = | |||
| |> List.flatten | |||
| in | |||
| let libraries = meta_libraries @ non_meta_libraries in | |||
| let pkg_dir = top_dir pkg in | |||
| let doc_dir = Fpath.(pkg_dir / "doc") in | |||
There was a problem hiding this comment.
The doc directory is back ? Is this to avoid breaking urls ?
There was a problem hiding this comment.
I chose not to change the layout on ocaml.org - mostly because it'd require a bunch of redesign work, and I don't have the capacity to do that.
jonludlam
force-pushed
the
further-voodoo
branch
from
0114e3f to
9c4deee
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Minor changes for voodoo mode