diff options
| author |   Martin Braun <martin.braun@ettus.com> | 2024-02-05 10:28:13 +0100 |
|---|---|---|
| committer |   Aki Tomita <121511582+atomita-ni@users.noreply.github.com> | 2024-02-14 21:53:16 -0600 |
| commit | 29f9e4e9fd4d14dd41cb78e6a57fe1522e25e8e7 (patch) | |
| tree | de3fb5ecb90b54a07514ea15c4d2808230c79c35 | |
| parent | cmake: Update UHDPython.cmake (diff) | |
| download | uhd-29f9e4e9fd4d14dd41cb78e6a57fe1522e25e8e7.tar.xz uhd-29f9e4e9fd4d14dd41cb78e6a57fe1522e25e8e7.zip | |
docs: Update build info
- Add section on Pybind11
- Fix a missing hard-coded version number for Python
- Note that Mako is used for runtime, too (image builder)
| -rw-r--r-- | host/docs/build.dox.in | 22 |
1 files changed, 20 insertions, 2 deletions
diff --git a/host/docs/build.dox.in b/host/docs/build.dox.in index 680e27a8d..84ca94e20 100644 --- a/host/docs/build.dox.in +++ b/host/docs/build.dox.in @@ -64,7 +64,7 @@ The directory to which you extract libusb must not contain spaces. This is to sa ### Python - **Purpose:** Used by mako build time, and utility scripts and the Python API at runtime -- **Minimum Version:** 3.5 +- **Minimum Version:** @PYTHON_MIN_VERSION@ - **Usage:** build time + runtime utility scripts (required) - **Download URL:** http://www.python.org/download/ - **Comments for Windows Users:** @@ -88,11 +88,29 @@ The directory to which you extract libusb must not contain spaces. This is to sa python3 -m pip3 install curses-2.2-cp37-cp37m-win_amd64.whl + +### Pybind11 + +<b>Note:</b> Pybind11 is shipped with UHD, and if no version of Pybind11 is +found in the usual paths, the in-tree version will be used. For compatibility +with other software that also uses Pybind11 (e.g., GNU Radio) it is generally +recommended to use the system version, but it is no requirement for UHD in +general. + +- **Purpose:** Used to build the UHD Python API +- **Minimum Version:** @PYBIND11_MIN_VERSION@ +- **Usage:** build time (for Python API only) +- **Download URL:** https://github.com/pybind/pybind11://github.com/pybind/pybind11/ +- **Alternative method:** As mentioned above, you don't have to install Pybind11 + yourself to enable the Python API. On most Linux distributions, it can be + installed through the package manager. + + ### Mako - **Purpose:** source code generation - **Minimum Version:** @PY_MAKO_MIN_VERSION@ -- **Usage:** build time (required) +- **Usage:** build time (required), RFNoC image builder (runtime) - **Download URL:** http://www.makotemplates.org/download.html - **Alternative method:** You can use `pip3` or `easy_install` to install Mako from PyPi. To install it using 'pip3' on Windows, navigate to Python scripts folder, e.g. `C:\local\Python37\Scripts`, and run the following command: |