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.

Sign up for GitHub

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

Jump to bottom

Scrape code examples from examples/ directory for Rustdoc #9525

Merged
merged 34 commits into from
Oct 28, 2021
Merged

Scrape code examples from examples/ directory for Rustdoc #9525

merged 34 commits into from
Oct 28, 2021

Commits on Oct 8, 2021

  1. Initial support for scrape-examples

    @willcrichton
    willcrichton committed Oct 8, 2021
    Configuration menu
    Copy the full SHA
    8acf0e8 View commit details
    Browse the repository at this point in the history

  2. Add repository URL

    @willcrichton
    willcrichton committed Oct 8, 2021
    Configuration menu
    Copy the full SHA
    3f9a4f2 View commit details
    Browse the repository at this point in the history

  3. Share all examples across each unit in worksapce

    @willcrichton
    willcrichton committed Oct 8, 2021
    Configuration menu
    Copy the full SHA
    a0122df View commit details
    Browse the repository at this point in the history

  4. Factor scraping and rendering into separate calls to rustdoc

    @willcrichton
    willcrichton committed Oct 8, 2021
    Configuration menu
    Copy the full SHA
    63c4346 View commit details
    Browse the repository at this point in the history

  5. Add workspace root

    @willcrichton
    willcrichton committed Oct 8, 2021
    Configuration menu
    Copy the full SHA
    49a3a54 View commit details
    Browse the repository at this point in the history

  6. Fix for issue rust-lang#9198

    @willcrichton
    willcrichton committed Oct 8, 2021
    Configuration menu
    Copy the full SHA
    4ac6835 View commit details
    Browse the repository at this point in the history

  7. Change cargo strategy to go through rustdoc instead of doctest

    @willcrichton
    willcrichton committed Oct 8, 2021
    Configuration menu
    Copy the full SHA
    b14a778 View commit details
    Browse the repository at this point in the history

  8. Add unstable notice for --scrape-examples

    @willcrichton
    willcrichton committed Oct 8, 2021
    Configuration menu
    Copy the full SHA
    711539f View commit details
    Browse the repository at this point in the history

  9. Remove unnecessary collect

    @willcrichton
    willcrichton committed Oct 8, 2021
    Configuration menu
    Copy the full SHA
    6772991 View commit details
    Browse the repository at this point in the history

  10. Fix test

    @willcrichton
    willcrichton committed Oct 8, 2021
    Configuration menu
    Copy the full SHA
    5ed35a4 View commit details
    Browse the repository at this point in the history

  11. Fix breakage

    @willcrichton
    willcrichton committed Oct 8, 2021
    Configuration menu
    Copy the full SHA
    d19cfd2 View commit details
    Browse the repository at this point in the history

  12. Allow scraping examples from library

    @willcrichton
    willcrichton committed Oct 8, 2021
    Configuration menu
    Copy the full SHA
    48056e5 View commit details
    Browse the repository at this point in the history

  13. Add comments

    @willcrichton
    willcrichton committed Oct 8, 2021
    Configuration menu
    Copy the full SHA
    ff13eb5 View commit details
    Browse the repository at this point in the history

  14. Fix documentation

    @willcrichton
    willcrichton committed Oct 8, 2021
    Configuration menu
    Copy the full SHA
    0c8e1f8 View commit details
    Browse the repository at this point in the history

  15. Add tracking issue and unstable documentation

    @willcrichton
    willcrichton committed Oct 8, 2021
    Configuration menu
    Copy the full SHA
    0b2e293 View commit details
    Browse the repository at this point in the history

  16. Pass metadata flag to rustdoc, ensure that Doc and Check units have s… 

    …ame metadata hash
    @willcrichton
    willcrichton committed Oct 8, 2021
    Configuration menu
    Copy the full SHA
    b9b39a6 View commit details
    Browse the repository at this point in the history

  17. Change metadata strategy to extract hash from nested compilation

    @willcrichton
    willcrichton committed Oct 8, 2021
    Configuration menu
    Copy the full SHA
    dbcabc7 View commit details
    Browse the repository at this point in the history

  18. Revert change to lift doc units

    @willcrichton
    willcrichton committed Oct 8, 2021
    Configuration menu
    Copy the full SHA
    0792cde View commit details
    Browse the repository at this point in the history

  19. Remove references to json

    @willcrichton
    willcrichton committed Oct 8, 2021
    Configuration menu
    Copy the full SHA
    82d937e View commit details
    Browse the repository at this point in the history

Commits on Oct 12, 2021

  1. Change scraping strategy to embed in existing unit graph, add Compile… 

    …Mode::Docscrape
    @willcrichton
    willcrichton committed Oct 12, 2021
    Configuration menu
    Copy the full SHA
    70f3821 View commit details
    Browse the repository at this point in the history

  2. Remove unused code

    @willcrichton
    willcrichton committed Oct 12, 2021
    Configuration menu
    Copy the full SHA
    d29ac15 View commit details
    Browse the repository at this point in the history

  3. Remove more unused code

    @willcrichton
    willcrichton committed Oct 12, 2021
    Configuration menu
    Copy the full SHA
    8331d7d View commit details
    Browse the repository at this point in the history

  4. Formatting

    @willcrichton
    willcrichton committed Oct 12, 2021
    Configuration menu
    Copy the full SHA
    223adac View commit details
    Browse the repository at this point in the history

Commits on Oct 13, 2021

  1. Fix issues compiling build scripts

    @willcrichton
    willcrichton committed Oct 13, 2021
    Configuration menu
    Copy the full SHA
    19c8f05 View commit details
    Browse the repository at this point in the history

  2. Add documentation and a test

    @willcrichton
    willcrichton committed Oct 13, 2021
    Configuration menu
    Copy the full SHA
    4705566 View commit details
    Browse the repository at this point in the history

  3. Remove references to "lib" argument

    @willcrichton
    willcrichton committed Oct 13, 2021
    Configuration menu
    Copy the full SHA
    17c6df7 View commit details
    Browse the repository at this point in the history

  4. Update rustdoc tests with -Cmetadata flag

    @willcrichton
    willcrichton committed Oct 13, 2021
    Configuration menu
    Copy the full SHA
    8b06a0f View commit details
    Browse the repository at this point in the history

Commits on Oct 14, 2021

  1. Add comments and todos

    @willcrichton
    willcrichton committed Oct 14, 2021
    Configuration menu
    Copy the full SHA
    e52a9d9 View commit details
    Browse the repository at this point in the history

  2. Add test / documentation for scrape-examples cycle-avoidance, add map… 

    … for doc unit -> metadata to Context
    @willcrichton
    willcrichton committed Oct 14, 2021
    Configuration menu
    Copy the full SHA
    b948fc8 View commit details
    Browse the repository at this point in the history

Commits on Oct 27, 2021

  1. Fix several bugs when checking wasmtime repo: 

    * Docscrape unit not having dev-dependencies included
* Sources for reverse-dependencies generated to the wrong directory
* Incorrect features being selected for Docscrape units
* Panics from Docscrape-dependent packages not being available
    @willcrichton
    willcrichton committed Oct 27, 2021
    Configuration menu
    Copy the full SHA
    e4a65b9 View commit details
    Browse the repository at this point in the history

  2. Remove unnecessary clones, document out_dir

    @willcrichton
    willcrichton committed Oct 27, 2021
    Configuration menu
    Copy the full SHA
    0deeea8 View commit details
    Browse the repository at this point in the history

Commits on Oct 28, 2021

  1. Change scraping to apply to all workspace packages instead of just 

    root units. Only attach Docscrape unit dependencies to workspace Doc
units. Add test for scraping examples with complex reverse dependencies.
    @willcrichton
    willcrichton committed Oct 28, 2021
    Configuration menu
    Copy the full SHA
    1120957 View commit details
    Browse the repository at this point in the history

  2. Formatting

    @willcrichton
    willcrichton committed Oct 28, 2021
    Configuration menu
    Copy the full SHA
    0a2382b View commit details
    Browse the repository at this point in the history

  3. Fix repeated warning with two calls to to_package_id_specs

    @willcrichton
    willcrichton committed Oct 28, 2021
    Configuration menu
    Copy the full SHA
    33718c7 View commit details
    Browse the repository at this point in the history