Skip to content
This repository has been archived by the owner on May 20, 2020. It is now read-only.

New Rustdoc can't document individual rs files #155

Open
euclio opened this issue Aug 11, 2017 · 3 comments
Open

New Rustdoc can't document individual rs files #155

euclio opened this issue Aug 11, 2017 · 3 comments

Comments

@euclio
Copy link
Contributor

euclio commented Aug 11, 2017

I think there's a bit of an mismatch between the fact that old rustdoc allows documenting individual files while the new rustdoc expects a crate with Cargo.toml. How do we want to handle that?

Another way of putting it is that the old rustdoc expects to be wrapped by cargo, while the new rustdoc expects to wrap cargo.

cc #125

@steveklabnik steveklabnik changed the title Reconcile old rustdoc strategy with new New Rustdoc can't document individual md files Aug 11, 2017
@steveklabnik
Copy link
Owner

steveklabnik commented Aug 14, 2017

@euclio
Copy link
Contributor Author

euclio commented Aug 14, 2017

Are we talking about the same thing? I originally opened the issue intending to talk about individual Rust files, not markdown. You can invoke the old rustdoc like rustdoc some_file.rs and it will create documentation for that file, without needing a Cargo.toml. Not saying we need to support that use case, but I'd like us to make an official decision.

@steveklabnik
Copy link
Owner

Oh!

Since that's just a crate root, yeah, okay. Let me change the title again; I misunderstood.

@steveklabnik steveklabnik changed the title New Rustdoc can't document individual md files New Rustdoc can't document individual rs files Aug 14, 2017
@euclio euclio mentioned this issue Aug 25, 2017
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants