Merge release v24.03

Author: pixar-oss

BUILDING.md

@@ -157,23 +157,45 @@ parse metadata from OSL shaders.
 Doxygen documentation can optionally be generated by specifying the cmake flag
 `PXR_BUILD_DOCUMENTATION=TRUE`.
 
-The additional dependencies that must be supplied for enabling documentation 
+There are two documentation sub-components, controlled by setting
+`PXR_BUILD_HTML_DOCUMENTATION` and `PXR_BUILD_PYTHON_DOCUMENTATION`. See the
+sections below for descriptions of precisely what they control.  Neither sub-
+component will have any effect if `PXR_BUILD_DOCUMENTATION` is not `TRUE`.
+
+The additional dependencies that must be supplied for enabling documentation
 generation are:
 
 | Dependency Name    | Description                             |
-| ------------------ |---------------------------------------  | 
+| ------------------ |---------------------------------------  |
 | DOXYGEN_EXECUTABLE | The location of Doxygen                 |
+
+See [3rd Party Library and Application Versions](VERSIONS.md) for version
+information, including supported Doxygen versions.
+
+##### HTML Documentation
+
+If `PXR_BUILD_HTML_DOCUMENTATION` evaluates `TRUE` then building of the HTML
+documentation is enabled.  This includes USD overview and general concepts, and
+the C++ API documentation.  It defaults to `TRUE`, and so is built by default
+when `PXR_BUILD_DOCUMENTATION` is also enabled (but has no effect if
+`PXR_BUILD_DOCUMENTATION` is not set.)
+
+The additional dependencies that must be supplied for enabling HTML
+documentation generation are:
+
+| Dependency Name    | Description                             |
+| ------------------ |---------------------------------------  |
 | DOT_EXECUTABLE     | The location of Dot(from GraphViz).     |
 
-See [3rd Party Library and Application Versions](VERSIONS.md) for version 
-information, including supported Doxygen and GraphViz versions.
+See [3rd Party Library and Application Versions](VERSIONS.md) for version
+information, including supported GraphViz versions.
 
 ##### Python Documentation
 
 Python docstrings for Python entities can be generated by specifying the cmake
 flag `PXR_BUILD_PYTHON_DOCUMENTATION`. This process requires that Python support
 (`PXR_ENABLE_PYTHON_SUPPORT`) and documentation (`PXR_BUILD_DOCUMENTATION`) are
-enabled. 
+enabled. It defaults to `FALSE`.
 
 This process uses the scripts in the docs/python subdirectory. Relevant
 documentation from generated doxygen XML data is extracted and matched with

CHANGELOG.md

@@ -62,13 +62,13 @@ endif()
 
 if (PXR_BUILD_DOCUMENTATION)
     pxr_build_documentation()
-endif()   
 
-# If building python doc strings, run script
-# that uses doxygen build results and installed
-# USD python modules
-if (PXR_BUILD_PYTHON_DOCUMENTATION)
-    pxr_build_python_documentation()
-endif()
+    # If building python doc strings, run script
+    # that uses doxygen build results and installed
+    # USD python modules
+    if (PXR_BUILD_PYTHON_DOCUMENTATION)
+        pxr_build_python_documentation()
+    endif()
+endif()   
 
 pxr_toplevel_epilogue()

CMakeLists.txt

@@ -111,18 +111,22 @@ You can download source code archives from [GitHub](https://www.github.com/Pixar
 
 ```
 > git clone https://github.com/PixarAnimationStudios/OpenUSD
-Cloning into 'USD'...
+Cloning into 'OpenUSD'...
 ```
 
 #### 3. Run the script
 
+Run the build_usd.py script to build and install USD. Note that the build script 
+is structured with an out-of-source build in mind -- installing a build into the  
+directory where the repository was cloned is untested. 
+
 ##### Linux:
 
 For example, the following will download, build, and install USD's dependencies,
-then build and install USD into `/usr/local/USD`.
+then build and install USD into `/path/to/my_usd_install_dir`.
 
 ```
-> python USD/build_scripts/build_usd.py /usr/local/USD
+> python USD/build_scripts/build_usd.py /path/to/my_usd_install_dir
 ```
 
 ##### MacOS:
@@ -131,10 +135,10 @@ In a terminal, run `xcode-select` to ensure command line developer tools are
 installed. Then run the script.
 
 For example, the following will download, build, and install USD's dependencies,
-then build and install USD into `/opt/local/USD`.
+then build and install USD into `/path/to/my_usd_install_dir`.
 
 ```
-> python USD/build_scripts/build_usd.py /opt/local/USD
+> python USD/build_scripts/build_usd.py /path/to/my_usd_install_dir
 ```
 
 ##### Windows:
@@ -146,10 +150,10 @@ command prompt and not the 32-bit (x86) command prompt.
 See https://docs.microsoft.com/en-us/cpp/build/how-to-enable-a-64-bit-visual-cpp-toolset-on-the-command-line for more details.
 
 For example, the following will download, build, and install USD's dependencies,
-then build and install USD into `C:\USD`.
+then build and install USD into `C:\path\to\my_usd_install_dir`.
 
 ```
-C:\> python USD\build_scripts\build_usd.py "C:\USD"
+C:\> python USD\build_scripts\build_usd.py "C:\path\to\my_usd_install_dir"
 ```
 
 #### 4. Try it out

README.md

@@ -13,13 +13,13 @@ Our test machines have the following software versions installed.
 
 | Software      | Linux                | macOS                        | Windows                        |
 | ------------- | -------------------- | ---------------------------- | ------------------------------ |
-| OS            | CentOS Linux 7       | 10.15.7                      | Windows 10                     |
+| OS            | CentOS Linux 7       | 12.6.3                       | Windows 10                     |
 | C++ Compiler  | gcc 9.3.1            | Apple clang 13.1.6 (Xcode 13.3) | Visual Studio 2017 15.9     |
 | CMake         | 3.17.5               | 3.19.5                       | 3.25.3                         |
 | Python        | 3.9.16               | 3.9.13                       | 3.9.13                         |
 | Boost         | 1.76.0               | 1.78.0                       | 1.76.0                         |
 | Intel TBB     | 2020 Update 3        | 2018 Update 1, 2020 Update 3 | 2020 Update 3                  |
-| OpenSubdiv    | 3.5.1                | 3.5.1                        | 3.5.1                          |
+| OpenSubdiv    | 3.6.0                | 3.6.0                        | 3.6.0                          |
 | OpenImageIO   | 2.3.21.0             | 2.3.21.0                     | 2.3.21.0                       |
 | OpenColorIO   | 2.1.3                | 2.1.3                        | 2.1.3                          |
 | OSL           | 1.10.9               |                              |                                |
@@ -37,5 +37,5 @@ Our test machines have the following software versions installed.
 | Doxygen       | 1.9.6                |                              |                                |
 | GraphViz      | 2.40.1               |                              |                                |
 | OpenVDB       | 9.1.0                | 7.1.0, 9.1.0                 | 9.1.0                          |
-| Vulkan SDK    | 1.2.135.0            | 1.2.135.0                    | 1.2.135.0                      |
+| Vulkan SDK    | 1.3.243.0            | 1.3.243.0                    | 1.3.243.0                      |
 | Draco         | 1.3.6                | 1.3.6                        | 1.3.6                          |

VERSIONS.md

@@ -60,6 +60,9 @@ stages:
         Python310:
           PYTHON_INTERPRETER: /opt/python/cp310-cp310/bin/python
           PYTHON_TAG: cp310
+        Python311:
+          PYTHON_INTERPRETER: /opt/python/cp311-cp311/bin/python
+          PYTHON_TAG: cp311
     timeoutInMinutes: 90
     pool:
       vmImage: Ubuntu-20.04
@@ -128,6 +131,9 @@ stages:
         Python310:
           PYTHON_VERSION_SPEC: 3.10
           PYTHON_TAG: cp310
+        Python311:
+          PYTHON_VERSION_SPEC: 3.11
+          PYTHON_TAG: cp311
     timeoutInMinutes: 90
     pool:
       vmImage: 'windows-2019'
@@ -187,6 +193,10 @@ stages:
           PYTHON_VERSION_SPEC: 3.10
           PYTHON_INTERPRETER: python3.10
           PYTHON_TAG: cp310
+        Python311:
+          PYTHON_VERSION_SPEC: 3.11
+          PYTHON_INTERPRETER: python3.11
+          PYTHON_TAG: cp311
     timeoutInMinutes: 180
     pool:
       vmImage: 'macOS-11'
@@ -284,6 +294,10 @@ stages:
           PYTHON_VERSION_SPEC: 3.10
           IMAGE: 'Ubuntu-20.04'
           PYTHON_INTERPRETER: python3
+        Linux_Python311:
+          PYTHON_VERSION_SPEC: 3.11
+          IMAGE: 'Ubuntu-20.04'
+          PYTHON_INTERPRETER: python3
         Windows_Python36:
           PYTHON_VERSION_SPEC: 3.6
           IMAGE: 'windows-2019'
@@ -304,6 +318,10 @@ stages:
           PYTHON_VERSION_SPEC: 3.10
           IMAGE: 'windows-2019'
           PYTHON_INTERPRETER: python
+        Windows_Python311:
+          PYTHON_VERSION_SPEC: 3.11
+          IMAGE: 'windows-2019'
+          PYTHON_INTERPRETER: python
         Mac_Python36:
           PYTHON_VERSION_SPEC: 3.6
           IMAGE: 'macOS-11'
@@ -324,6 +342,10 @@ stages:
           PYTHON_VERSION_SPEC: 3.10
           IMAGE: 'macOS-11'
           PYTHON_INTERPRETER: python3
+        Mac_Python311:
+          PYTHON_VERSION_SPEC: 3.11
+          IMAGE: 'macOS-11'
+          PYTHON_INTERPRETER: python3
     timeoutInMinutes: 10
     pool:
       vmImage: '$(IMAGE)'