Cross package odoc page links
Open
Nobody has claimed this yet.
cross-referencer
enhancement
- Dominant language
- OCaml
- Stars
- 355
- Forks
- 114
- Avg merge
- 6d 21h
- Merged PRs (30d)
- 10
Description
Unless I'm missing something it's not possible to make cross-package odoc pages links. I tried with something like:
{{!Odig.page-manual.odoc_themes}odig's odoc theme}
to link from a package to odig's manual here but got the error:
Expected 'module-', 'module-type-', 'type-', 'class-', 'class-type-', or an unqualified reference.
It would be nice to abe able to.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reproducing the cross-package reference from odig's doc/manual.mld using the reported {{!Odig.page-manual.odoc_themes}...} syntax and inspect odoc's reference handling. Done means a package can link to a page in another package without the reported reference error, with coverage for the cross-package case.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ocaml
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100