Add binaryninjacore-sys
to online docs
#6294
Labels
Component: Documentation
Issue needs changes to our documentation
Component: Rust API
Issue needs changes to the Rust API
Effort: Trivial
Issue should take < 1 day
Is this a general concept that needs to be documented or a specific API?
Currently, https://dev-rust.binary.ninja hosts the rust api docs, but not the
binaryninjacore-sys
docs. Tagging the-sys
crate with the correcthtml_root_url
tag and uploading it under the same domain would yield major benefits to rust users. For one, it would allow to see the auto generated bindings without building them locally, and second, it would automatically link type aliases of the wrapper crate to the original source. That way enum values and the likes can be inspected without, again, building the docs for the-sys
crate locally.Are there any known examples of people using this API/concept?
All that needs to be done is to add the
binaryninjacore-sys
crate to the list of crates to be built for docs and uploaded to the same html root folder that is also used to serve thebinaryninja
crate docs. The 2 crates do not need to have their docs built at the same time for this to work.The text was updated successfully, but these errors were encountered: