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

Give the Unstable Book a title #59554

Closed
frewsxcv opened this issue Mar 30, 2019 · 9 comments
Closed

Give the Unstable Book a title #59554

frewsxcv opened this issue Mar 30, 2019 · 9 comments
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools C-enhancement Category: An issue proposing an enhancement or a PR with one. E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue.

Comments

@frewsxcv
Copy link
Member

Similar to rust-lang/rfcs#2669, but for the Unstable Book

Right now, titles look like: <title>emit_stack_sizes - </title>

To do this, we might just need to add a book.toml file in this directory
@frewsxcv frewsxcv added the A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools label Mar 30, 2019
@jonas-schievink jonas-schievink added E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. C-enhancement Category: An issue proposing an enhancement or a PR with one. labels Mar 30, 2019
@gruberb gruberb mentioned this issue Mar 30, 2019
Merged
@gruberb
Copy link
Contributor

gruberb commented Mar 30, 2019

I created a PR for this issue. The title I added is "The Rust Unstable Book". Or should it just be "The Unstable Book"?

@frewsxcv
Copy link
Member Author

What you have looks great, thanks!

Centril added a commit to Centril/rust that referenced this issue Mar 30, 2019
@Centril
Rollup merge of rust-lang#59569 - gruberb:add-title-for-unstable-book…
bb10b54 
…, r=frewsxcv

Add book.toml with title to unstable-book doc

Adding a title to the unstable book based on rust-lang#59554
Centril added a commit to Centril/rust that referenced this issue Mar 30, 2019
@Centril
Rollup merge of rust-lang#59569 - gruberb:add-title-for-unstable-book…
7da27b2 
…, r=frewsxcv

Add book.toml with title to unstable-book doc

Adding a title to the unstable book based on rust-lang#59554
@Centril Centril closed this as completed Apr 1, 2019
@frewsxcv frewsxcv reopened this Apr 4, 2019
@frewsxcv
Copy link
Member Author

frewsxcv commented Apr 4, 2019

Looks like there's still no title set after #59569 🤔

@gruberb
Copy link
Contributor

gruberb commented Apr 4, 2019

Hmm... I'll check later when I am
home!

@gruberb
Copy link
Contributor

gruberb commented Apr 4, 2019

@frewsxcv I double checked and it seems it's not being able to compile since there is no SUMMARY.md. When I run it locally the title is there, but the index is empty.

So I'll add a SUMMARY.md and create a new PR.

@frewsxcv
Copy link
Member Author

frewsxcv commented Apr 4, 2019

It's been a while since I looked at this code, so not entirely sure how it all works, but I think the summary.md file is generated here: https://github.com/rust-lang/rust/tree/master/src/tools/unstable-book-gen/src

@gruberb
Copy link
Contributor

gruberb commented Apr 4, 2019

I see. I took inspiration from the other books (like embedded). When I reproduce it for the unstable book, I get the title and everything.

So maybe I just have to add the book.toml to the unstable-book-gen folder. I never touched the books before so I am not sure why the unstable book behaves differently.

@ehuss
Copy link
Contributor

ehuss commented Apr 5, 2019

@gruberb The unstable book is generated by a tool (unstable-book-gen) which processes and copies the files from src/doc/unstable-book to build/*/md-doc/unstable-book and then mdbook is run against that folder to save the output to build/*/doc/unstable-book.

I would probably edit unstable-book-gen to copy the book.toml file over along with the source files.

@gruberb gruberb mentioned this issue Apr 6, 2019
Merged
Centril added a commit to Centril/rust that referenced this issue Apr 12, 2019
@Centril
Rollup merge of rust-lang#59747 - gruberb:copy-book-toml-unstable-boo…
ef08a1c 
…k, r=ehuss

Copy book.toml unstable book generator

Solves rust-lang#59554 and adds a book title to the unstable book.

I assume that [copy_recursive](https://github.com/rust-lang/rust/blob/acd8dd6a50d505057a7d7ad8d0d7a4c2bd274200/src/tools/unstable-book-gen/src/main.rs#L105) will take files regardless of their type (`.md` or `.toml`).

Although I had a hard time time testing it. A second pair of eyes is definitely needed.
Centril added a commit to Centril/rust that referenced this issue Apr 13, 2019
@Centril
Rollup merge of rust-lang#59747 - gruberb:copy-book-toml-unstable-boo…
edc3979 
…k, r=ehuss

Copy book.toml unstable book generator

Solves rust-lang#59554 and adds a book title to the unstable book.

I assume that [copy_recursive](https://github.com/rust-lang/rust/blob/acd8dd6a50d505057a7d7ad8d0d7a4c2bd274200/src/tools/unstable-book-gen/src/main.rs#L105) will take files regardless of their type (`.md` or `.toml`).

Although I had a hard time time testing it. A second pair of eyes is definitely needed.
Centril added a commit to Centril/rust that referenced this issue Apr 13, 2019
@Centril
Rollup merge of rust-lang#59747 - gruberb:copy-book-toml-unstable-boo…
8ac023f 
…k, r=ehuss

Copy book.toml unstable book generator

Solves rust-lang#59554 and adds a book title to the unstable book.

I assume that [copy_recursive](https://github.com/rust-lang/rust/blob/acd8dd6a50d505057a7d7ad8d0d7a4c2bd274200/src/tools/unstable-book-gen/src/main.rs#L105) will take files regardless of their type (`.md` or `.toml`).

Although I had a hard time time testing it. A second pair of eyes is definitely needed.
Centril added a commit to Centril/rust that referenced this issue Apr 13, 2019
@Centril
Rollup merge of rust-lang#59747 - gruberb:copy-book-toml-unstable-boo…
d34ebb4 
…k, r=ehuss

Copy book.toml unstable book generator

Solves rust-lang#59554 and adds a book title to the unstable book.

I assume that [copy_recursive](https://github.com/rust-lang/rust/blob/acd8dd6a50d505057a7d7ad8d0d7a4c2bd274200/src/tools/unstable-book-gen/src/main.rs#L105) will take files regardless of their type (`.md` or `.toml`).

Although I had a hard time time testing it. A second pair of eyes is definitely needed.
@frewsxcv
Copy link
Member Author

seems to be working now, thanks @gruberb!

https://doc.rust-lang.org/nightly/unstable-book/language-features/infer-static-outlives-requirements.html

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools C-enhancement Category: An issue proposing an enhancement or a PR with one. E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
5 participants
@ehuss @frewsxcv @Centril @jonas-schievink @gruberb