Skip to content

Doc and rustdoc cross-document cross-references #12554

Closed
@brson

Description

@brson
Contributor

Right now every piece of documentation we have is self-contained, without an easy way to write hyperlinks between them. As we ramp up our documentation efforts it's important that we be able to link our docs together.

I'm thinking the first step is to unify our pandoc and rustdoc toolchains (#11392), then teach rustdoc some way to do links between documents.

Activity

steveklabnik

steveklabnik commented on Apr 16, 2015

@steveklabnik
Member

This is not likely to get fixed anytime soon, as Markdown doesn't have any kind of standard for how to mark up something like this. As it would be a pretty big extension / change, I'd imagine this would go through the RFC process, since Rustdoc is part of the Rust distribution, and so I'm going to give it a close here. In practice, writing manual links leads to breakgage sometimes, but it's not too hard to fix, and we have other bugs open to try to and keep up with 404s more generally.

added a commit that references this issue on Jul 25, 2022

Auto merge of rust-lang#12554 - XFFXFF:fix_11959, r=Veykril

added a commit that references this issue on Apr 4, 2024

Auto merge of rust-lang#12554 - Kobzol:assigning-clones-unspecified, …

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Development

      No branches or pull requests

        Participants

        @steveklabnik@brson

        Issue actions

          Doc and rustdoc cross-document cross-references · Issue #12554 · rust-lang/rust