acc6718c51
Address review comments in #1286 .
2022-01-05 23:26:43 -06:00
a992723654
Streamline "Getting Started" some more.
...
This is a follow-up to #1279 .
The "Getting Started" chapter is, TBH, pretty bad when it comes to the
stuff about building and testing. It has far too much detail and lots of
repetition, which would be overwhelming to a newcomer.
This commit removes most of it, leaving behind just quick mentions of
the most common `x.py` commands: `check`, `build`, `test`, `fmt`, with
links to the appropriate chapters for details. There were a few
interesting details that weren't covered elsewhere, so I moved those
into other chapters.
2022-01-05 23:26:43 -06:00
f9db2f4478
Update rustdoc internals
...
Use current paths when discussing source files.
Update cheat sheet section with download-rustc.
Add "use cases" section.
2021-12-09 16:05:48 -06:00
8faa1646f5
Remove `--stage 1` argument from `doc` invocations ( #1125 )
2021-05-18 19:10:39 +02:00
d1e2f3bf50
Fix rustdocs test command typo ( #1103 )
2021-04-04 01:41:35 +09:00
dfe398bd5a
Fix a link about Rustdoc internals
2021-04-02 05:25:14 -04:00
c431f8c29a
Cleanup rustdoc chapters a bit
...
* Rename "The walking tour of rustdoc" to "Rustdoc overview",
which I think is a more accurate name
* Use same name in sidebar TOC as in chapter text
* Make links between the two chapters prominent
* Convert a few `.html` links to `.md`
Probably we should just merge the chapters, but leaving that for later.
2021-02-28 16:35:20 -05:00
55c7be5d83
Link to the Rustdoc book in the rustdoc chapter ( #981 )
...
This makes a) makes it easier to find info about rustdoc's features and
b) redirects people in the wrong place to where they should be looking.
2020-12-04 18:23:46 +01:00
f8012dbf42
Rename `src/libstd` to `library/std` etc. ( #815 )
2020-07-30 22:47:22 +09:00
eeca3757b8
Update docs to match the new x.py defaults ( #813 )
2020-07-29 04:20:00 +09:00
2e104620d1
Move x.py commands to overview
2020-06-23 17:40:16 -05:00
4329b8e91a
Split up rustdoc page
2020-06-23 17:40:16 -05:00
178e3052b2
Document rustdoc behavior
...
- `RUSTDOC_LOG`
- `// aux-build:filename.rs`
- `// build-aux-docs`
2020-06-17 09:24:41 -05:00
2ef6c927d1
Fix links and paths
2020-01-10 13:12:39 -05:00
efe3ab7ad1
Revert "website has disappeared"
...
This reverts commit 0930e773f1
2019-11-26 21:00:47 -06:00
0930e773f1
website has disappeared
2019-11-26 17:05:11 -06:00
c4ac71e1d0
Fix typos
...
These were fixed using [codespell](https://github.com/codespell-project/codespell ).
2018-09-12 07:32:18 +02:00
addc94950a
don't mention new rustdoc
...
Steve says it's not ready
(https://github.com/rust-lang-nursery/rustc-guide/pull/150#issuecomment-395783504 ).
2018-06-25 21:18:50 -05:00
c98cd5a6a8
include `./` in example x.py commands for smoother copy-paste experience
...
The current directory is typically not on the user's $PATH.
2018-06-25 21:18:50 -05:00
43341c8894
Consolidate and fix code blocks
2018-04-06 14:18:08 -05:00
3c189daf2c
Fix typo in rustdoc.md
2018-04-03 10:15:57 -05:00
066ba9ef82
reformat basically the whole rustdoc.md
2018-03-26 20:28:00 -05:00
81071c6838
Updated parenthetical
2018-03-15 15:00:10 -05:00
7c2af89682
address review comments
2018-03-15 15:00:10 -05:00
21ed6e6ce4
Address review comments
2018-03-15 15:00:10 -05:00
a19cdc7a71
Add the rustdoc readme
2018-03-15 15:00:10 -05:00
Nicholas Nethercote
Jacob Hoffman-Andrews
Justus K
二手掉包工程师
Yuki Okushi
Camelid
Joshua Nelson
Yuki Okushi
Who? Me?!
Mark Mansi
Philipp Hansch
Zack M. Davis
varkor
Philip Munksgaard