nix(docs): patch odoc-driver to fix source links, add sherlodoc www - #246
Open
katrinafyi wants to merge 3 commits into
Open
nix(docs): patch odoc-driver to fix source links, add sherlodoc www#246katrinafyi wants to merge 3 commits into
odoc-driver to fix source links, add sherlodoc www#246katrinafyi wants to merge 3 commits into
Conversation
katrinafyi
force-pushed
the
odoc-source-fix
branch
from
August 21, 2026 03:25
5c2890b to
b4a4a39
Compare
katrinafyi
force-pushed
the
odoc-source-fix
branch
from
August 21, 2026 03:49
b4a4a39 to
c6df8ef
Compare
katrinafyi
force-pushed
the
odoc-source-fix
branch
from
August 21, 2026 04:29
9e83567 to
1f2dae9
Compare
katrinafyi
force-pushed
the
odoc-source-fix
branch
from
August 24, 2026 01:32
1f2dae9 to
5bb9f8d
Compare
katrinafyi
force-pushed
the
odoc-source-fix
branch
from
August 24, 2026 06:06
5bb9f8d to
a88af2f
Compare
katrinafyi
force-pushed
the
odoc-source-fix
branch
from
August 25, 2026 04:59
a88af2f to
71c27f2
Compare
primarily, changes src for `odoc-driver` package and changes it to be a wrapped program with direct references to sherlodoc and odoc. this means that users of `odoc-driver` do not need to manually make sure that those are on their path and they all have compatible versions. changes sherlodoc package to add a flag for `enableWww` which aims to bring back `sherlodoc serve` support for hosting a local version of https://doc.sherlocode.com/. this is there but not used yet, as it still needs a lot of work. a lot of things are hard-coded to ocaml.org.
katrinafyi
force-pushed
the
odoc-source-fix
branch
from
August 25, 2026 05:50
71c27f2 to
f84bb6b
Compare
…bdirs` it's not used atm though
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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 patches odoc to work towards fixing this issue: https://www.github.com/ocaml/odoc/issues/1475.
blahis a test package which usesinclude_subdirsto check that the source linking works.this is the bug in current docs where the "Source" link doesn't work https://uq-pac.github.io/bincaml/bincaml/bincaml.transforms/Transforms/index.html#module-Aslp
primarily, changes src for
odoc-driverpackage and changes it to be a wrapped program with direct references to sherlodoc and odoc. this means that users ofodoc-driverdo not need to manually make sure that those are on their path and they all have compatible versions.changes sherlodoc package to add a flag for
enableWwwwhich aims to bring backsherlodoc servesupport for hosting a local version of https://doc.sherlocode.com/. this is there but not used yet, as it still needs a lot of work. a lot of things are hard-coded to ocaml.org.