[docs] fixes for python docstring builds on windows

PixarAnimationStudios · Oct 17, 2023 · a623c9f · a623c9f
1 parent db8d57d
commit a623c9f
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 0 deletions.
diff --git a/cmake/macros/Public.cmake b/cmake/macros/Public.cmake
@@ -1282,6 +1282,7 @@ function(pxr_build_python_documentation)
                 --package pxr --module ${pxrPythonModulesStr} \
                 --inputIndex ${BUILT_XML_DOCS}/index.xml \
                 --pythonPath ${CMAKE_INSTALL_PREFIX}/lib/python \
+                --libPath \"${CMAKE_INSTALL_PREFIX}/lib;${CMAKE_INSTALL_PREFIX}/bin;${CMAKE_INSTALL_PREFIX}/plugin/usd;${CMAKE_INSTALL_PREFIX}/share/usd/examples/plugin\" \
                 --output ${INSTALL_PYTHON_PXR_ROOT})
         if (NOT \${convert_doxygen_return_code} EQUAL \"0\")
             message( FATAL_ERROR \"Error generating python docstrings - ${CONVERT_DOXYGEN_TO_PYTHON_DOCS_SCRIPT} return code: \${convert_doxygen_return_code} \")

diff --git a/docs/python/convertDoxygen.py b/docs/python/convertDoxygen.py
@@ -49,6 +49,7 @@
 output_file   = GetArgValue(['--output', '-o'])
 output_format = GetArgValue(['--format', '-f'], "Docstring")
 python_path = GetArgValue(['--pythonPath'])
+lib_path = GetArgValue(['--libPath'])
 
 SetDebugMode(GetArg(['--debug', '-d']))
 
@@ -62,6 +63,20 @@
 if (python_path != None):
     sys.path.append(python_path)
 
+if lib_path != None:
+    lib_paths = lib_path.replace("/", os.sep).split(";")
+    if os.name == "nt":
+        for path in lib_paths:
+            if os.path.isdir(path):
+                os.add_dll_directory(path)
+    else:
+        ld_lib_paths = os.environ.get("LD_LIBRARY_PATH", "").split(os.pathsep)
+        for path in lib_paths:
+            if path not in ld_lib_paths:
+                ld_lib_paths.append(path)
+        os.environ["LD_LIBRARY_PATH"] = os.pathsep.join(ld_lib_paths)
+
+
 #
 # Try to import the plugin module that creates the desired output
 #

diff --git a/docs/python/doxygenlib/cdUtils.py b/docs/python/doxygenlib/cdUtils.py
@@ -134,6 +134,7 @@ def Usage():
   --debug or -d   = turn on debugging mode
   --help or -h    = display this program usage statement
   --pythonPath    = optional path to add to python lib paths
+  --libPath       = optional ;-separated paths to allow library loading from
 
 Docstring format:
   Write Python doc strings from Doyxgen C++ comments. Writes