Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

rustbuild: Build documentation for proc_macro #40199

Merged
merged 1 commit into from
Mar 11, 2017

Commits on Mar 10, 2017

  1. rustbuild: Build documentation for proc_macro

    This commit fixes rust-lang#38749 by building documentation for the `proc_macro` crate by
    default for configured hosts. Unfortunately did not turn out to be a trivial
    fix. Currently rustbuild generates documentation into multiple locations: one
    for std, one for test, and one for rustc. The initial fix for this issue simply
    actually executed `cargo doc -p proc_macro` which was otherwise completely
    elided before.
    
    Unfortunately rustbuild was the left to merge two documentation trees together.
    One for the standard library and one for the rustc tree (which only had docs for
    the `proc_macro` crate). Rustdoc itself knows how to merge documentation files
    (specifically around search indexes, etc) but rustbuild was unaware of this, so
    an initial fix ended up destroying the sidebar and the search bar from the
    libstd docs.
    
    To solve this issue the method of documentation has been tweaked slightly in
    rustbuild. The build system will not use symlinks (or directory junctions on
    Windows) to generate all documentation into the same location initially. This'll
    rely on rustdoc's logic to weave together all the output and ensure that it ends
    up all consistent.
    
    Closes rust-lang#38749
    alexcrichton committed Mar 10, 2017
    Configuration menu
    Copy the full SHA
    f846aaf View commit details
    Browse the repository at this point in the history