Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add binaryninjacore-sys to online docs #6294

Open
greaka opened this issue Jan 1, 2025 · 1 comment · May be fixed by #6309
Open

Add binaryninjacore-sys to online docs #6294

greaka opened this issue Jan 1, 2025 · 1 comment · May be fixed by #6309
Assignees
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

Comments

@greaka
Copy link

greaka commented Jan 1, 2025

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 correct html_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 the binaryninja crate docs. The 2 crates do not need to have their docs built at the same time for this to work.

@emesare emesare self-assigned this Jan 1, 2025
@emesare emesare added Effort: Trivial Issue should take < 1 day Component: Rust API Issue needs changes to the Rust API Component: Documentation Issue needs changes to our documentation labels Jan 1, 2025
@emesare
Copy link
Member

emesare commented Jan 2, 2025

This commit should hopefully solve this issue 47d55c7

Blocking on https://github.com/Vector35/binaryninja-api/tree/rust_cleanup_0

@emesare emesare linked a pull request Jan 11, 2025 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants