diff --git a/README.md b/README.md index a022ac2908..c182f9cb94 100644 --- a/README.md +++ b/README.md @@ -60,6 +60,14 @@ static GLOBAL: Jemalloc = Jemalloc; Jemalloc is known to cause crashes when a binary compiled for x86 is run on an Apple silicon-based Mac under [Rosetta 2](https://support.apple.com/en-us/HT211861). If you are experiencing crashes on your Apple silicon Mac, run `rustc --print target-libdir`. The output should contain `aarch64-apple-darwin`. If the output contains `x86_64-apple-darwin`, then you are running the Rust toolchain for x86; we recommend switching to the native ARM version. +## Documentation + +Generate documentation locally: + +```sh +cargo doc --no-deps --open +``` + ## Contributing guidelines See [CONTRIBUTING.md](./CONTRIBUTING.md). diff --git a/plonky2/Cargo.toml b/plonky2/Cargo.toml index 59ae921243..5338bcabbf 100644 --- a/plonky2/Cargo.toml +++ b/plonky2/Cargo.toml @@ -87,3 +87,4 @@ harness = false # Display math equations properly in documentation [package.metadata.docs.rs] rustdoc-args = ["--html-in-header", ".cargo/katex-header.html"] +cargo-args = ["--no-deps"] diff --git a/starky/Cargo.toml b/starky/Cargo.toml index 33d90d5b4d..993d223daa 100644 --- a/starky/Cargo.toml +++ b/starky/Cargo.toml @@ -36,3 +36,4 @@ env_logger = { version = "0.9.0", default-features = false } # Display math equations properly in documentation [package.metadata.docs.rs] rustdoc-args = ["--html-in-header", ".cargo/katex-header.html"] +cargo-args = ["--no-deps"]