Skip to content

rustdoc: Allow customizing the crate list sidebar. #16328

Open
@SimonSapin

Description

@SimonSapin

http://doc.servo.org/servo/index.html is the rustdoc documentation for Servo’s own crates, those of all dependencies (submodules), and Rust’s (for the version used by Servo, which is usually a few weeks behind Rust master.)

Currently, this is a total of 69 crates that are listed in alphabetical order. Instead, I would like the sidebar to have three sub-sections (Servo, submodules, and Rust) each listing the corresponding crates. The sidebar is generated by a copy of src/librustdoc/html/static/main.js, and therefore is not easy to customize.

Could rustdoc help with this? Perhaps, rather than adding a feature for exactly what Servo wants, enable arbitrary behavior by providing a hook for overriding the bit of JS that generates the sidebar?

Metadata

Metadata

Assignees

No one assigned

    Labels

    A-rustdoc-uiArea: Rustdoc UI (generated HTML)C-enhancementCategory: An issue proposing an enhancement or a PR with one.T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.T-rustdoc-frontendRelevant to the rustdoc-frontend team, which will review and decide on the web UI/UX output.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions