Support relative links between crates?
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 1.2k
- Forks
- 232
- Avg merge
- 11h 35m
- Merged PRs (30d)
- 60
Description
Example: Rand has multiple crates in the same repo.
We have been using relative links between the crates, e.g.:
[`BlockRng`]: ../../../rand_core/block/struct.BlockRng.html
If we build doc with cargo doc --all, these links work fine locally. They do not work on docs.rs (e.g. block BlockRng here).
Is there a good solution for this? We'd prefer not to use absolute links to docs.rs. We have documentation here which resolves the cross-linking just fine.
Contributor guide
No contributing guide indexed for this repository
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 relative-link behavior with cargo doc --all for a project containing multiple crates, then compare the generated links with the failing example on docs.rs. The work is complete when cross-crate relative links such as the BlockRng reference resolve on docs.rs without requiring absolute docs.rs URLs.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100