Port the reference to mdbook #39855
Port the reference to mdbook #39855
Conversation
|
@steveklabnik: no appropriate reviewer found, use r? to override |
|
Will it still be available as a single |
|
@petrochenkov IIRC the "print" view gives you that. And, if for some reason it doesn't, fixing it in mdbook is quite possible. There's already a ticket open for actual search, for example. |
Ha, indeed. I never noticed this little icon. The reference is mostly useless in multi-page format since it's primarily used for looking up stuff by keyword. I'd really like to see it single-page by default.
If this search is going to remind the Discource search in any way, then that ticked would better stay open. |
|
One wrinkle I noticed while doing this; mdbook doesn't support rustdoc's footnote syntax, which is really only used in the reference, if I recall. We'll have to handle those too. |
|
@frewsxcv given https://github.com/azerupi/mdBook/issues/204 you might not want to mess with the links yet; if they change the way they're generated, you'd have to do a second pass... |
|
☔ The latest upstream changes (presumably #39761) made this pull request unmergeable. Please resolve the merge conflicts. |
|
Hm, mdbook should support footnotes, given that pulldown-cmark does: https://github.com/google/pulldown-cmark/blob/master/tests/footnotes.rs |
|
I've sent in https://github.com/azerupi/mdBook/pull/207; let's see. |
steveklabnik
force-pushed
the
mdbook-reference
branch
from
b01076e
to
8260a36
Compare
|
I've built this off of my PR now; we'll see what's up. @frewsxcv if you want to work on the links, fixing these ones should be fine; they'll be much more similar and less of them will be broken. @alexcrichton I don't know how okay we are with working with forks of projects; I know @azerupi is busy at the moment, and it's been less than a day, so I don't want to rush him; I also don't know how long we want to block on upstream issues. |
|
Update, /cc @alexcrichton it looks like this is landing upstream soon, so I'll fix this up after it lands and we don't need to use my fork 😄 |
|
👍 |
|
Oh but yeah for now let's avoid github forks, let's stick to crates.io where we can |
|
Status: upstream is merged but needs a crates.io release. |
|
Updated mdbook PR made separately: #39966 |
|
☔ The latest upstream changes (presumably #39966) made this pull request unmergeable. Please resolve the merge conflicts. |
steveklabnik
force-pushed
the
mdbook-reference
branch
from
8260a36
to
4aedf0b
Compare
|
Blocked on #39976 |
|
☔ The latest upstream changes (presumably #39981) made this pull request unmergeable. Please resolve the merge conflicts. |
steveklabnik
force-pushed
the
mdbook-reference
branch
from
4aedf0b
to
021405e
Compare
|
This is now ready to go; all we need are fixing up the links. @frewsxcv is on it! ❤️ |
|
I've pushed a commit to deal with the footnotes, and opened https://github.com/azerupi/mdBook/issues/210 so we can address it upstream as well. |
|
At this point, all of the links in the reference itself are updated. Still gotta do the standard library and the book... |
This only really moves the files, there's a lot more work coming in the next commits. Part of rust-lang#39588.
I double checked that everything is here and in the correct order; this fixes things up
This affects the book, some missed things in the reference, the grammar, and the standard library. Whew!
Until https://github.com/azerupi/mdBook/issues/210 is resolved, we'll import the css file.
steveklabnik
force-pushed
the
mdbook-reference
branch
from
37c4218
to
55c02f6
Compare
|
This should now be good to go! 😄 /cc @rust-lang/docs |
|
Given that both @frewsxcv and I worked on this, I guess r? @GuillaumeGomez ❤️ |
|
Seems all good to me (that was quite the review...). Thanks to both of you! @bors: r+ |
|
📌 Commit 55c02f6 has been approved by |
Port the reference to mdbook Part of #39588. This is only a work in progress. Still left to do: - [x] double check contents weren't duplicated/lost with the move to individual pages (I'm going to do this) - [x] fix up links [and footnotes](#39855 (comment)) (@frewsxcv has volunteered to help with this) - [x] change `src/doc/reference.md` to redirect to the book - [x] move the reference on the doc index to be part of the bookshelf
|
☀️ Test successful - status-appveyor, status-travis |
Part of #39588.
This is only a work in progress. Still left to do:
src/doc/reference.mdto redirect to the book