The zkpass-client API Reference is available as Rust doc pages.
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-sdk
repository on your local system. When following these instructions, please substitute /home/builder/zkpass-sdk
with the actual path to your project's root directory.
To generate the zkpass-client lib documentation locally, do the following:
After completing these steps, you can find the generated documentation in the ~/rust/target/doc
directory within the crate's source code directory.
On Ubuntu/Linux:
Run the following:
On WSL (Windows Subsystem for Linux):
Type the following in the browser's address box:
This assumes your WSL instance name is 'Ubuntu'. If you are using a different name, please replace the instance name as appropriate.