diff options
| author | Jordan Wiens <jordan@psifertex.com> | 2023-12-22 21:26:17 -0500 |
|---|---|---|
| committer | Jordan Wiens <jordan@psifertex.com> | 2023-12-22 21:26:17 -0500 |
| commit | 24504c4cf6bdc9acd90e4f95fd7185ae61b1030d (patch) | |
| tree | 0df98fec43a0e2c75e08290f78159e3789fcd5b1 | |
| parent | 66be2657a30056b99fab83c7211092f288b44e69 (diff) | |
add more documentation about specifying the full path for install_api.py
| -rw-r--r-- | docs/dev/batch.md | 4 | ||||
| -rw-r--r-- | rust/src/lib.rs | 2 | ||||
| -rwxr-xr-x | scripts/install_api.py | 4 |
3 files changed, 9 insertions, 1 deletions
diff --git a/docs/dev/batch.md b/docs/dev/batch.md index 3fb4ddfa..220a677e 100644 --- a/docs/dev/batch.md +++ b/docs/dev/batch.md @@ -19,6 +19,10 @@ First, make sure to run the [install_api.py](https://github.com/Vector35/binaryn python3 ~/binaryninja/scripts/install_api.py ``` +Note +???+ Warning "Tip" + If you have multiple python copies installed, you'll want to make sure to specify the full path to the correct python when running as shown above. + This script adds appropriate `.pth` files so that your Python can find the Binary Ninja libraries. ## Our First Script diff --git a/rust/src/lib.rs b/rust/src/lib.rs index d6161d53..d9ea2d46 100644 --- a/rust/src/lib.rs +++ b/rust/src/lib.rs @@ -16,7 +16,7 @@ #![allow(clippy::missing_safety_doc)] #![allow(clippy::result_unit_err)] #![allow(clippy::type_complexity)] -#![doc(html_no_source)] +#![doc(html_root_url = "https://dev-rust.binary.ninja/binaryninja/")] #![doc(html_favicon_url = "/favicon.ico")] #![doc(html_logo_url = "/logo.png")] #![doc(issue_tracker_base_url = "https://github.com/Vector35/binaryninja-api/issues/")] diff --git a/scripts/install_api.py b/scripts/install_api.py index cd0c93b7..5e93064b 100755 --- a/scripts/install_api.py +++ b/scripts/install_api.py @@ -1,4 +1,8 @@ #!/usr/bin/env python3 +# Note, you probably want to run this script directly +# so you can be explicit about _which_ python version you +# wish to add binaryninja to the path of. For example: +# /usr/bin/python3 install_api.py # # Do not run this from a github clone. Should be used # by running the system native python and pointing it at |
