-
Notifications
You must be signed in to change notification settings - Fork 414
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add package-level mlds to odoc include path #2016
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good. Please update gen_tests.ml like the other odoc tests. Tests need to specify they introduce external dependencies.
test/blackbox-tests/test-cases/odoc-package-mld-link/odoc_page_link_bug.opam
Outdated
Show resolved
Hide resolved
|
||
$ dune build @doc | ||
|
||
$ grep -r xref-unresolved _build/default/_doc/_html/odoc_page_link_bug/index.html |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It might make sense of just build this target directly. It will make the tests a tad quicker.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah, good idea, fixed.
Don't forget to update the change log by the way |
CHANGES.md
Outdated
@@ -1,6 +1,10 @@ | |||
unreleased | |||
---------- | |||
|
|||
- Fix invocation of odoc to add previously missing include paths, impacting | |||
mld files that are not in directories containing libraries (fixes #2007, | |||
@jonludlam) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should also include the PR number.
Should I rebase/force push to resolve the out-of-date issue or hit the 'update branch' button? |
I'm used to doing it manually. I think either one should work. |
Currently failing, this is ocaml/odoc#2007 Signed-off-by: Jon Ludlam <[email protected]>
Fixes ocaml#2007 Signed-off-by: Jon Ludlam <[email protected]>
Signed-off-by: Jon Ludlam <[email protected]>
Suggestions due to @rgrinberg Signed-off-by: Jon Ludlam <[email protected]>
Signed-off-by: Jon Ludlam <[email protected]>
CHANGES: - Fix invocation of odoc to add previously missing include paths, impacting mld files that are not in directories containing libraries (ocaml/dune#2016, fixes ocaml/dune#2007, @jonludlam)
This ensures links to/from docs that exist outside of a library are correctly resolved.