Dedicated sidebar file #1250
Merged
Dedicated sidebar file #1250
Conversation
This file contains hidden or 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
panglesd
added a commit
to panglesd/odoc
that referenced
this pull request
Nov 18, 2024
jonludlam
pushed a commit
to jonludlam/odoc
that referenced
this pull request
Nov 21, 2024
panglesd
added a commit
to panglesd/odoc
that referenced
this pull request
Nov 21, 2024
panglesd
force-pushed
the
root-in-sidebar
branch
from
e6ff8d0 to
0031767
Compare
jonludlam
pushed a commit
to jonludlam/odoc
that referenced
this pull request
Nov 25, 2024
jonludlam
pushed a commit
to jonludlam/odoc
that referenced
this pull request
Nov 28, 2024
Julow
reviewed
Dec 2, 2024
src/odoc/sidebar.ml
Outdated
| open_out_bin (Fs.File.to_string output) | ||
| in | ||
| let output = Format.formatter_of_out_channel output_channel in | ||
| Format.fprintf output "%s" text |
Collaborator
There was a problem hiding this comment.
It's best practice to close the channel. We have Fun.protect in utils to help close properly.
src/odoc/sidebar.ml
Outdated
| ("modules", `Array (List.map (Tree.to_json toc_to_json) units)); | ||
| ] | ||
|
|
||
| let sidebar_to_json ({ pages; libraries } : Odoc_document.Sidebar.t) = |
Collaborator
There was a problem hiding this comment.
Shouldn't this function be in the HTML generator ? That's where the other JSON function are located.
The HTML generator is used in these functions.
src/odoc/sidebar.ml
Outdated
| let sidebar_to_json ({ pages; libraries } : Odoc_document.Sidebar.t) = | ||
| let pages = List.map pages_to_json pages in | ||
| let libraries = List.map libs_to_json libraries in | ||
| `Object [ ("pages", `Array pages); ("libraries", `Array libraries) ] |
Collaborator
There was a problem hiding this comment.
The JSON is slightly confusing with two things called pages. Shouldn't this be called manuals ?
Collaborator
Author
There was a problem hiding this comment.
Hmm, anyway this changes to a more generic sidebar json in #1251.
And not the index file, to avoid doing multiple times the same thing
panglesd
force-pushed
the
root-in-sidebar
branch
from
0031767 to
180676a
Compare
panglesd
added a commit
to panglesd/sherlodoc
that referenced
this pull request
Dec 9, 2024
Several changes: - Entries are now defined in the `odoc_index` library, - Entries can have new kinds (pages, source, ...) - Indexes have the form of "skeletons of entries", that can be folded. - Indexes can be created by odoc with the `odoc compile-index` command, and then consumed by sherlodoc. These changes come from: - ocaml/odoc#1228 - ocaml/odoc#1232 - ocaml/odoc#1233 - ocaml/odoc#1244 - ocaml/odoc#1250 - ocaml/odoc#1251
jonludlam
pushed a commit
to jonludlam/odoc
that referenced
this pull request
Dec 10, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This PR adds a
odoc sidebar-generatecommand which takes an index (.odoc-index) as input and produces a sidebar file (.odoc-sidebaror.jsonif--jsonis passed).This allows to reduce the time spent HTML generating, as sidebar files are much smaller than index files (they don't contain values and other entries that are not shown in the sidebar anyway).
The json format is likely to change with #1247.