Broken links in `String` documentation from `Deref` impl

[alexcrichton]

There are a bunch of links in the String documentation page which are broken. The reason for this is that most links are drawn from the documentation of the str type at /std/primitive.str.html but the String page is located at /std/string/struct.String.html. This mismatch in depth of paths causes a number of broken links, for example on the String::split method.

Not sure of the best way to fix this, but needs a tracking issue.

[durka]

It would be most awesome if there were some way to link to an item in Rustdoc, not just putting in a link URL, but that's perhaps out of scope for now. Maybe just some basic variable substitution, so you could write [foo]($htmlroot/bar/baz/foo.html)?

[alexcrichton]

Yeah I suspect some basic substitution could work especially because we control the markdown rendering. I'd be a little wary to add API surface area to rustdoc, but it seems minorly well motivated?

[durka]

It seems pretty much required to put in some facility for linking without relative URLs, because Deref copies and pastes things around.

[steveklabnik]

It would be nice if we could follow the work CommonMark is doing here, so we're not totally just inventing a new thing.

http://talk.commonmark.org/t/generic-directives-plugins-syntax/444 seems to be at least one relevant discussion.

[mitaa]

That seems like a nice long-term solution, that'd have to be implemented in hoedown however.

There is an old issue regarding this on their repo: hoedown/hoedown#99

[steveklabnik]

yes, I would like to move from hoedown to pulldown-cmark, personally.

[frewsxcv]

Opened an issue for moving to pulldown-cmark: #38400