aptos-core icon indicating copy to clipboard operation
aptos-core copied to clipboard

Published 20 hours ago • verified publisher icon aptos-labs

Test rustdoc ouput for potential use (DO NOT MERGE)

Open clay-aptos opened this issue 3 years ago • 2 comments

Description

Using cargo doc to generate rustdoc output for the Rust SDK in aptos-core/sdk

Test Plan

Will need to be prepared and staged per: https://dev.to/deciduously/prepare-your-rust-api-docs-for-github-pages-2n5i

Using: https://github.com/diem/diem/blob/b4699202fb7b48874d974c99628c8f277cc98189/developers.diem.com/scripts/build_docs.sh#L84-L105

Thanks to @gregnazario for his help preparing and @geekflyer for evaluating.

This change is Reviewable

clay-aptos avatar Oct 13 '22 21:10 clay-aptos

Hi team,

What do you think of proceeding with this?

clay-aptos avatar Oct 18 '22 22:10 clay-aptos

Hi team,

What do you think of proceeding with this?

Related, I am noting @wrwg has impressively enabled Move auto-gen docs in: https://github.com/aptos-labs/aptos-core/pull/5187

clay-aptos avatar Oct 20 '22 22:10 clay-aptos