Merge pull request #172 from tbirdso/comments

DOC: Update documentation for shared library command line arguments

Author: thewtex

scripts/internal/manylinux-build-module-wheels.sh

@@ -1,6 +1,20 @@
 #!/usr/bin/env bash
 
-# Run this script inside a dockcross container to build Python wheels for an ITK module
+# Run this script inside a dockcross container to build Python wheels for an ITK module.
+#
+# Versions can be restricted by passing them in as arguments to the script.
+# For example,
+#
+#   /tmp/dockcross-manylinux-x64 manylinux-build-module-wheels.sh cp39
+#
+# Shared library dependencies can be included in the wheel by mounting them to /usr/lib64 or /usr/local/lib64 
+# before running this script.
+# 
+# For example,
+#
+#   DOCKER_ARGS="-v /path/to/lib.so:/usr/local/lib64/lib.so"
+#   /tmp/dockcross-manylinux-x64 -a "$DOCKER_ARGS" manylinux-build-module-wheels.sh
+#
 
 # -----------------------------------------------------------------------
 # These variables are set in common script:

scripts/internal/manylinux-build-wheels.sh

@@ -1,5 +1,21 @@
 #!/usr/bin/env bash
 
+# Run this script inside a dockcross container to build Python wheels for ITK.
+#
+# Versions can be restricted by passing them in as arguments to the script.
+# For example,
+#
+#   /tmp/dockcross-manylinux-x64 manylinux-build-wheels.sh cp39
+#
+# Shared library dependencies can be included wheels by mounting them to /usr/lib64 or /usr/local/lib64 
+# before running this script.
+# 
+# For example,
+#
+#   DOCKER_ARGS="-v /path/to/lib.so:/usr/local/lib64/lib.so"
+#   /tmp/dockcross-manylinux-x64 -a "$DOCKER_ARGS" manylinux-build-wheels.sh
+#
+
 # -----------------------------------------------------------------------
 # These variables are set in common script:
 #

scripts/macpython-build-module-wheels.sh

@@ -7,6 +7,15 @@
 # For example,
 #
 #   scripts/macpython-build-module-wheels.sh 2.7 3.5
+#
+# Shared libraries can be included in the wheel by exporting them to DYLD_LIBRARY_PATH before
+# running this script.
+# 
+# For example,
+#
+#   export DYLD_LIBRARY_PATH="/path/to/libs"
+#   scripts/macpython-build-module-wheels.sh cp39
+#
 
 # -----------------------------------------------------------------------
 # These variables are set in common script:

scripts/macpython-build-wheels.sh

@@ -6,6 +6,15 @@
 # For example,
 #
 #   scripts/macpython-build-wheels.sh 3.9
+#
+# Shared libraries can be included in the wheel by exporting them to DYLD_LIBRARY_PATH before
+# running this script.
+# 
+# For example,
+#
+#   export DYLD_LIBRARY_PATH="/path/to/libs"
+#   scripts/macpython-build-module-wheels.sh cp39
+#
 
 # -----------------------------------------------------------------------
 # These variables are set in common script:

scripts/windows_build_module_wheels.py

@@ -1,3 +1,7 @@
+#!/usr/bin/env python
+
+# See usage with .\scripts\windows_build_module_wheels.py --help
+
 from subprocess import check_call
 import os
 import glob