Skip to content

Commit 4de3f89

Browse files
committed
document existing setup
1 parent 5e16c66 commit 4de3f89

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

src/doc/unstable-book/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Unstable Book
2+
3+
These are the sources for <https://doc.rust-lang.org/nightly/unstable-book/>.
4+
To generate them, run `./x doc unstable-book`, which will generate HTML files in `build/host/doc/unstable-book` using `src/tools/rustbook`.
5+
If you need to change the overall structure, modify `src/tools/unstable-book-gen/src/SUMMARY.md`.
6+
7+
Note that most of this book is autogenerated by `unstable-book-gen`, with the exception of `compiler-flags` and `compiler-environment-variables`.
8+
As a result, it does not integrate well with `mdbook`. Use `./x doc` instead.

0 commit comments

Comments
 (0)