Skip to content

Cargo doc #2583

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

Closed
wants to merge 2 commits into from
Closed

Cargo doc #2583

wants to merge 2 commits into from

Conversation

GuillaumeGomez
Copy link
Member

Continuation of #2256.

cc @steveklabnik

@alexcrichton: Do you want to set a thread limit (I didn't implement them yet but the code is in place)?

What's remaining:

  • Find out why html generation from markdown fails.
  • Add an option to disable the html generation for doc/ files.
  • Add tests.

@rust-highfive
Copy link

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @huonw (or someone else) soon.

If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes.

Please see the contribution instructions for more information.

@alexcrichton
Copy link
Member

Thanks for the PR! The more I think about this the more I'm convinced that we may want to push it into the backend infrastructure (the cargo_rustc module) as that will buy us:

  • Correct tracking of inputs, e.g. memoizing the output if no input has changed.
  • Parallelization
  • Working with cross-compiled docs
  • Extensibility in terms of filtering what to build, building only the dependencies for that, etc.

This can likely largely be done by modifying the Profile structure with a new flag and then modifying where to-compile targets are generated to generate a bunch of doc targets if we're documenting something.

@alexcrichton
Copy link
Member

Closing due to inactivity, but feel free to reopen with comments addressed!

@GuillaumeGomez
Copy link
Member Author

I'm still trying to figure all this out. I'm not used to cargo architecture so I'm mostly reading code for now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants