Building Rust doc

Follow the instructions below to build the Rust doc yourself from the source code.

In this documentation, we refer to the project directory as /home/builder/zkpass-sdk. This path is used as an example that represents the root directory of the clonedzkpass-sdkrepository on your local system. When following these instructions, please substitute /home/builder/zkpass-sdkwith the actual path to your project's root directory.

Generating the Rust doc

To generate the zkpass-client lib documentation locally, do the following:

cd ~/zkpass-sdk/rust
cargo doc -p dvr_types --no-deps --open

After completing these steps, the documentation will automatically open on a browser or you can find the generated documentation in the ~/rust/target/doc directory within the crate's source code directory.