feat: use output from new doc-ci with odoc 3 features in the package documentation area #3124
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
Co-authored-by: Jon Ludlam <[email protected]>
Co-authored-by: Jon Ludlam <[email protected]>
4 tasks
panglesd
force-pushed
the
odoc-3.0-reworked
branch
from
3c7ef34 to
62e8c97
Compare
Co-authored-by: Jon Ludlam <[email protected]>
It was added in ocaml/odoc#1314 and needs not be ignored Co-authored-by: Jon Ludlam <[email protected]>
Co-authored-by: Jon Ludlam <[email protected]>
Co-authored-by: Jon Ludlam <[email protected]>
panglesd
force-pushed
the
odoc-3.0-reworked
branch
2 times, most recently
from
9a5f418 to
62d32b9
Compare
|
I converted this to a draft, but feel free to ping me any time when it makes sense to test this. I will put this on https://staging.ocaml.org, and hook it up with the staging docs-ci. |
sabine
changed the title
sabine
changed the title
Co-authored-by: Jon Ludlam <[email protected]>
Co-authored-by: Jon Ludlam <[email protected]>
Co-authored-by: Jon Ludlam <[email protected]>
Co-authored-by: Jon Ludlam <[email protected]>
Odoc 3 allows to have breadcrumbs without href. Currently, the breadcrumbs are still computed by ocaml.org, but soon it will be taken from odoc3's json output. Co-authored-by: Jon Ludlam <[email protected]>
With odoc 3 and hierarchical documentation, breadcrumbs will include pages. They are rendered with `/` between them (while other components are rendered with `.` between them). So We can have `library1/Module.Submodule`. Pages cannot yet happen since we still compute breadcrumbs ourselves. Co-authored-by: Jon Ludlam <[email protected]>
Co-authored-by: Jon Ludlam <[email protected]>
Co-authored-by: Jon Ludlam <[email protected]>
|
Does this make #1963 obsolete? |
Yes. |
From https://alpinejs.dev/directives/cloak : > Sometimes, when you're using AlpineJS for a part of your template, there is a > "blip" where you might see your uninitialized template after the page loads, > but before Alpine loads. > > `x-cloak` addresses this scenario by hiding the element it's attached to until > Alpine is fully loaded on the page. > > For `x-cloak` to work however, you must add the following CSS to the page. > > ``` > [x-cloak] { display: none !important; } > ```
panglesd
force-pushed
the
odoc-3.0-reworked
branch
from
52920b2 to
3f494dd
Compare
Since odoc 3, and the replacement of voodoo by odoc_driver as the odoc driver, the layout for docs has changed. Since we do not want to break previously existing links, we redirect the old layout to the new one.
|
@sabine @jonludlam This is ready for testing on staging! (I don't know what makes the "deployability" CI fail but I don't think it's related) |
|
Deploying on staging.ocaml.org (https://deploy.ci.ocaml.org/job/2025-06-06/074257-ocluster-build-384752) |
|
The source rendering needs some CSS love: 
|
|
Did you take the screenshot from staging.ocaml.org? Here is how the same page looks for me: Light mode: Dark mode: I'll try to reproduce with different browser and settings, but if you have any hint, I'll take them. |
Documentation assets are not present as json files. Therefore, if we do not find a .json target, we try to load it as an asset. This is not ideal: assets always require two requests to the documentation server. 404 pages also trigger two requests...
|
Ok, testing on chromium yields the same CSS problem... |
|
Deploying updated PR to staging. |
panglesd
force-pushed
the
odoc-3.0-reworked
branch
from
6c9e7de to
b30d4c1
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.
Replaces #3123, but PR is on
main.This PR uses the output from the new doc-ci @jonludlam has been working on. The docs are built with odoc 3, benefiting from several features, some of them that were previously "emulated" on this repo (such as a global sidebar).
This currently implements:
This PR is not yet complete, however all pushed commits can already be reviewed, so I think it was already worth opening.
I tried to make the commits as atomic as possible to ease the review, which can then be made "commit by commit". All commits compile, although they may fail at runtime (eg due to wrong format for deserializing).
I'll post updates and warn when I consider the PR complete!