diff options
| author | jyn <github@jyn.dev> | 2025-05-24 19:45:37 -0400 |
|---|---|---|
| committer | jyn <github@jyn.dev> | 2025-05-24 19:49:21 -0400 |
| commit | 4de3f8975a1336b6a601188edf0033ec25843972 (patch) | |
| tree | 02e33183b171cd18c3a029c16f87922c5572cf30 | |
| parent | 5e16c662062fd6dee91f0fe2a1580483488d80cf (diff) | |
| download | rust-4de3f8975a1336b6a601188edf0033ec25843972.tar.gz rust-4de3f8975a1336b6a601188edf0033ec25843972.zip | |
document existing setup
| -rw-r--r-- | src/doc/unstable-book/README.md | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/src/doc/unstable-book/README.md b/src/doc/unstable-book/README.md new file mode 100644 index 00000000000..7acdd32857f --- /dev/null +++ b/src/doc/unstable-book/README.md @@ -0,0 +1,8 @@ +# Unstable Book + +These are the sources for <https://doc.rust-lang.org/nightly/unstable-book/>. +To generate them, run `./x doc unstable-book`, which will generate HTML files in `build/host/doc/unstable-book` using `src/tools/rustbook`. +If you need to change the overall structure, modify `src/tools/unstable-book-gen/src/SUMMARY.md`. + +Note that most of this book is autogenerated by `unstable-book-gen`, with the exception of `compiler-flags` and `compiler-environment-variables`. +As a result, it does not integrate well with `mdbook`. Use `./x doc` instead. |