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

Ship "the rustdoc book" #42322

Closed
6 of 7 tasks
carols10cents opened this issue May 31, 2017 · 4 comments
Closed
6 of 7 tasks

Ship "the rustdoc book" #42322

carols10cents opened this issue May 31, 2017 · 4 comments
Assignees
@steveklabnik
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools C-tracking-issue Category: A tracking issue for an RFC or an unstable feature. P-high High priority T-dev-tools Relevant to the dev-tools subteam, which will review and decide on the PR/issue.

Comments

@carols10cents
Copy link
Member

carols10cents commented May 31, 2017 •
edited by steveklabnik
Loading

Located here: https://github.com/rust-lang/rust/tree/master/src/doc/rustdoc/src

This book documents Rustdoc and all its options. To do:

It's no use, Mr. James – it's turtles docs all the way down.

Originally filed as rust-lang/book#725:
@carols10cents carols10cents added the T-dev-tools Relevant to the dev-tools subteam, which will review and decide on the PR/issue. label May 31, 2017
@carols10cents carols10cents mentioned this issue May 31, 2017
Closed
@steveklabnik steveklabnik mentioned this issue Jun 2, 2017
Merged
bors added a commit that referenced this issue Jun 7, 2017
@bors
Auto merge of #42378 - steveklabnik:rustdoc-docs, r=frewsxcv
f062832 
The Rustdoc book

A work-in-progress start for docs for rustdoc.

This doesn't actually generate the docs yet; I wanted to open this PR to get feedback on this approach, the chapters headings themselves, and to see if anyone wanted to help fill in the ones that aren't done yet.

Start of #42322.

/cc @rust-lang/dev-tools @rust-lang/docs
@steveklabnik steveklabnik changed the title Document the rustdoc tool and all its options Ship "the rustdoc book" Jun 7, 2017
@steveklabnik steveklabnik added E-help-wanted Call for participation: Help is requested to fix this issue. P-medium Medium priority A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools labels Jun 7, 2017
@steveklabnik steveklabnik self-assigned this Jun 7, 2017
@steveklabnik steveklabnik added P-high High priority and removed P-medium Medium priority labels Jun 7, 2017
@steveklabnik
Copy link
Member

Moving to p-high and assigning myself; i'd like to get this resolved in the next release cycle. If anyone else wants to pitch in, please let me know!

@QuietMisdreavus QuietMisdreavus mentioned this issue Jun 7, 2017
Closed
@steveklabnik steveklabnik mentioned this issue Jun 8, 2017
Closed
@Mark-Simulacrum Mark-Simulacrum added the C-tracking-issue Category: A tracking issue for an RFC or an unstable feature. label Jul 27, 2017
@chordowl chordowl mentioned this issue Aug 10, 2017
Closed
6 tasks
@steveklabnik
Copy link
Member

@carols10cents the above has an environment variables bullet, but I can't find any environment variables in librustdoc. Were there ones you were thinking about? Maybe I'm bad at grepping...

@steveklabnik steveklabnik mentioned this issue Aug 10, 2017
Merged
@carols10cents
Copy link
Member Author

I have exactly 0 recollection of filing this issue, but the turtles all the way down image has me written all over it, so I must have. This is awfully suspicious though:

carols10cents on May 30 • edited by steveklabnik (Steve Klabnik)

(This is the only vaguely env var related code i could find on a cursory glance?](https://github.com/rust-lang/rust/blob/master/src/librustdoc/test.rs#L285-L299)

@steveklabnik
Copy link
Member

Great, I'm just going to check it off then. If we magically discover one then we can add it, but I'm pretty sure there's nothing.

steveklabnik added a commit to steveklabnik/rust that referenced this issue Aug 10, 2017
@steveklabnik
Document the doc attribute
99e943c 
cc rust-lang#42322
This was referenced Aug 10, 2017
Merged
Merged
bors added a commit that referenced this issue Aug 12, 2017
@bors
Auto merge of #43792 - steveklabnik:rustdoc-directives, r=frewsxcv
2fa5340 
Document the doc attribute

cc #42322
bors added a commit that referenced this issue Aug 12, 2017
@bors
Auto merge of #43812 - steveklabnik:rustdoc-doc-tests, r=QuietMisdreavus
59f6b83 
rustdoc doc tests

This is mostly adapted from the book v1's chapter.

cc #42322

r? @rust-lang/docs
@steveklabnik steveklabnik mentioned this issue Aug 14, 2017
Merged
steveklabnik added a commit to steveklabnik/rust that referenced this issue Aug 14, 2017
@steveklabnik
Write the "passes" chapter of the rustdoc book
7a5ee17 
cc rust-lang#42322
frewsxcv added a commit to frewsxcv/rust that referenced this issue Aug 15, 2017
@frewsxcv
Rollup merge of rust-lang#43790 - steveklabnik:rustdoc-passes, r=Quie…
b1bdf13 
…tMisdreavus

Write the "passes" chapter of the rustdoc book

cc rust-lang#42322

r? @rust-lang/docs
@frewsxcv frewsxcv removed the E-help-wanted Call for participation: Help is requested to fix this issue. label Aug 15, 2017
bors added a commit that referenced this issue Aug 15, 2017
@bors
Auto merge of #43863 - steveklabnik:ship-the-rustdoc-book, r=frewsxcv
c774c95 
Ship the rustdoc book

Fixes #42322, as it's the last step.

Blocked on #43790, though they will not conflict.

r? @rust-lang/docs
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@steveklabnik steveklabnik

Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools C-tracking-issue Category: A tracking issue for an RFC or an unstable feature. P-high High priority T-dev-tools Relevant to the dev-tools subteam, which will review and decide on the PR/issue.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@steveklabnik @carols10cents @frewsxcv @Mark-Simulacrum