Stefan Habel

Sphinx Python Documentation

3

Work in progress. This PR adds a new build target named `MaterialXDocsPython`, which generates Python API documentation using Sphinx. The existing developer guide contents are incorporated into the new HTML...

Generating Python API docs

4

This PR adds support for generating Python API documentation in HTML format using Sphinx from the MaterialX Python modules that are built in the `lib/` directory. A new CMake build...

Similar to https://github.com/AcademySoftwareFoundation/MaterialX/pull/2051, https://github.com/AcademySoftwareFoundation/MaterialX/pull/2061, https://github.com/AcademySoftwareFoundation/MaterialX/pull/2063, https://github.com/AcademySoftwareFoundation/MaterialX/pull/2064, and https://github.com/AcademySoftwareFoundation/MaterialX/pull/2065. Also fixing a couple of typos in Metal header files. | Before | After | |-|-| | ![Screenshot 2024-10-13 at 17 16...

Similar to https://github.com/AcademySoftwareFoundation/MaterialX/pull/2051, https://github.com/AcademySoftwareFoundation/MaterialX/pull/2061, https://github.com/AcademySoftwareFoundation/MaterialX/pull/2063, and https://github.com/AcademySoftwareFoundation/MaterialX/pull/2064. | Before | After | |-|-| |  |  | Split from...

Similar to https://github.com/AcademySoftwareFoundation/MaterialX/pull/2051, https://github.com/AcademySoftwareFoundation/MaterialX/pull/2061 and https://github.com/AcademySoftwareFoundation/MaterialX/pull/2063. Also fixed a typo in `MslShaderGenerator.h`. Split from #1567. Update #342.

Similar to https://github.com/AcademySoftwareFoundation/MaterialX/pull/2051 and https://github.com/AcademySoftwareFoundation/MaterialX/pull/2061. | Before | After | |-|-| |  |  | | ![Screenshot 2024-10-13 at...

Similar to https://github.com/AcademySoftwareFoundation/MaterialX/pull/2051. Also noting a quirk: The `Format` and `Type` enums are exposed at the module level, not as part of the `FilePath` class. | Before | After |...

Mostly copied from corresponding C++ header files, but using backticks to automatically link to relevant sections in the Python API documentation, e.g. `Document` to link to `PyMaterialXCore.Document.html`. Using `mod.attr("").doc() =...