Skip to content

Commit

Permalink
Remove comment about nightly being necessary to build docs index.html
Browse files Browse the repository at this point in the history
It isn't (anymore).
  • Loading branch information
cronokirby authored and erwanor committed Dec 15, 2023
1 parent 92d2f00 commit 50103f2
Showing 1 changed file with 1 addition and 3 deletions.
4 changes: 1 addition & 3 deletions docs/rustdoc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,7 @@ This directory is empty except for the firebase config file we use to deploy
rustdoc output, because the contents of the documentation are inline with the
source code. We use it to stage the rustdoc output for deployment in CI.

The `index.html` can only be generated using nightly Rust, which we want to
avoid in CI, because (1) it interferes with caching and (2) sometimes causes
breakage. When the list of built crates in the `deployments/scripts/rust-docs` script
When the list of built crates in the `deployments/scripts/rust-docs` script
changes, the `index.html` can be regenerated by setting `REGENERATE_INDEX=1`
like so:

Expand Down

0 comments on commit 50103f2

Please sign in to comment.