Contrib doc #28815
Merged
Contrib doc #28815
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
|
||
| [adocs]: https://github.com/rust-lang/rust/issues?q=is%3Aopen+is%3Aissue+label%3AA-docs | ||
|
|
||
| To render documentation you can use rustdoc. For example, `rustdoc | ||
| src/doc/reference.md` will render reference to `doc/reference.html`. The css | ||
| might be messed up, but you can verify that html is right. |
There was a problem hiding this comment.
Thanks for this!
The English is great. 😄 A few things:
rustdocshould be in graves, so it renders like code.- CSS and HTML not css and html
- Can you add something to indicate that this might not always work? Something like
In many cases, you don't need a full
make doc. You can userustdocdirectly to check small fixes. For example...
There was a problem hiding this comment.
Should be OK now. Should I squash the last two commits?
|
Yes please! |
|
rebased |
|
@bors: r+ rollup |
|
📌 Commit c3753ce has been approved by |
bors
added a commit
that referenced
this pull request
Oct 3, 2015
This adds a paragraph on how to generate documentation without sloooow `make doc`. I'm not a native English speaker, so there might be some language related bugs (I wish English was as hard to get wrong, as Rust) This also includes whitespace cleanup of contributing.md in a separate commit. Whiltespace is not significant in github flavored markdown, and my Emacs just cleans ws automatically :) r? @steveklabnik
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds a paragraph on how to generate documentation without sloooow
make doc. I'm not a native English speaker, so there might be some language related bugs (I wish English was as hard to get wrong, as Rust)This also includes whitespace cleanup of contributing.md in a separate commit. Whiltespace is not significant in github flavored markdown, and my Emacs just cleans ws automatically :)
r? @steveklabnik