Sphinx Python Documentation #1567

StefanHabel · 2023-10-13T01:36:31Z

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 documentation, which lives side-by-side to the existing Doxygen-generated C++ API documentation.

Docstrings were added to all modules, functions, classes, methods, and attributes.

All parameters were named. None should appear as arg0, arg1, arg2 etc anymore.

Statistics about the Python API have been added to the Sphinx build process.

The Sphinx build output currently ends with the following messages, providing an overview of the state of the API docs:

The MaterialX Python API consists of:
    * 11 modules
    * 48 functions
    * 139 classes
    * 1180 methods
    * 6 exception types

build succeeded.

Docstring example:

$ python3 -c 'import PyMaterialXFormat; help(PyMaterialXFormat.flattenFilenames)'

Help on built-in function flattenFilenames in module PyMaterialXFormat:

flattenFilenames(...) method of builtins.PyCapsule instance
    flattenFilenames(doc: PyMaterialXCore.Document, searchPath: PyMaterialXFormat.FileSearchPath = mx.FileSearchPath(), customResolver: PyMaterialXCore.StringResolver = None) -> None

    Flatten all filenames in the given document, applying string resolvers at
    the scope of each element and removing all fileprefix attributes.

    :param doc: The document to modify.
    :type doc: Document
    :param searchPath: An optional search path for relative to absolute path
        conversion.
    :type searchPath: FileSearchPath
    :param customResolver: An optional custom resolver to apply.
    :type customResolver: StringResolver

Preview of generated HTML pages:

Development environment:

Apple clang version 15.0.0 (clang-1500.0.40.1)
Python 3.12.0 (v3.12.0:0fb18b02c8, Oct 2 2023, 09:45:56) [Clang 13.0.0 (clang-1300.0.29.30)] on darwin
Sphinx 7.2.6
cmake version 3.27.6

Update #342

linux-foundation-easycla · 2023-10-13T01:36:35Z

The committers listed above are authorized under a signed CLA.

✅ login: StefanHabel / name: Stefan Habel (bef6e1f, 9d4b492, e129d65, 6a5da31, e1113ea, e4382bb, c983b87, 3567610, abc2edb, 133a0b4, 67bb241, e715c0f, 6a9d8e5, 2c04542, 8790578, 0439c07, 1e745bd, 4c11bde, 9d73ddc, 0e1e502, 805f13c, c0d65ed, ab6860b, 26a972f, b8eecc0, bf427e4, fbe2947, f064a22, d30276b, 86030d0, 90c78d4, aed7f8f, 052f38e, 939c996, 77b5944, be2db5e, 71bd3fd, f7bea44, e66a3f5, 28fd863, 74872ea, 572089b, 513ef90, c9a2469, 21eecdd, 40079f1, dfa106a, f62be3a, 77ca69c, 6253abc, c1b31c0, 0ca9f23, f73acc4, b589282)
✅ login: jstone-lucasfilm / name: Jonathan Stone (37f1ef5)

kwokcb

This is a great addition to have !
I left some minor niggly comments. The only real question I had is any inter-dependence on building the actual Python modules.
Thanks.

documents/DeveloperGuide/ShaderGeneration.md

documents/DeveloperGuide/index.rst

documents/sphinx-custom.css

documents/CMakeLists.txt

kwokcb · 2023-10-13T14:09:39Z

documents/DeveloperGuide/GraphEditor.md

-### Example Images
+## Example Images
+
+![MaterialX Graph Editor with procedural marble example](../Images/MaterialXGraphEditor_Marble.png)


Not specific to this PR but I noticed that images don't show up properly on the PyPi package page for MaterialX.
If were adding more images, just curious is there a more robust way to specify image references -- such as an absolute reference to the web site location instead of using relative paths ?

Oh, I see the issue: https://pypi.org/project/materialx/

It's great to see that the documentation content is reused in many places!

I've migrated the Markdown docs, including README.md, to use absolute paths now:

e129d65

The update of these markdown files has been split off into its own PR: #2037

cmake/modules/FindSphinx.cmake

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 documentation, which lives side-by-side to the existing Doxygen-generated C++ API documentation. The docstrings of the Python modules were tweaked to describe what the individual modules are responsible for. Signed-off-by: Stefan Habel <19556655+StefanHabel@users.noreply.github.com>

…MATERIALX_BUILD_PYTHON_DOCS build option.

…d Markdown files to use absolute URLs. This is to make sure the URLs can be loaded within GitHub, Doxygen, Sphinx, and the PyPI project page. Requires internet access. Also updated XML text snippets to use XML comment delimiters.

…d `index.rst`. Changed index page title, added introduction text, and changed the order of Python modules, to reflect the order in which support for the different shading languages was added to MaterialX.

…ed import order dependency issue. This patch adds calls of `pybind11::module::import()` to the Python bindings of modules that depend on specific other modules. This approach is similar to importing required modules via `import` in Python packages/modules. At the same time, we can remove the new documentation for this issue, and can remove extra steps from the Sphinx `conf.py` configuration file. With this patch in place, it should be possible to import any of the MaterialX Python modules in any order.

…d Sphinx configuration. - Added a new description/about text in the sidebar, including blue link buttons to GitHub and MaterialX on Mastodon (with an SVG-based embedded icon) - Applied the "monokai" syntax highlighting theme to code snippets - Added custom Jinja templates for classes and modules, in order to add a section title before the alphabetical indices on pages - Added a custom HTML template for the navigation section in the sidebar in order to limit the depth of the table of contents - Added code to remove module names from the signatures of functions, in order to make the docs more readable

…a couple of typos in header files.

…define to produce detailed error messages in pybind11.

…docstrings to PyMaterialXCore.

…docstrings to PyMaterialXFormat.

…docstrings to PyMaterialXGenGlsl.

…docstrings to PyMaterialXGenMdl.

…docstrings to PyMaterialXGenMsl.

…docstrings to PyMaterialXGenOsl.

…docstrings to PyMaterialXGenShader.

…docstrings to PyMaterialXRender.

…docstrings to PyMaterialXRenderGlsl.

…docstrings to PyMaterialXRenderMsl.

…docstrings to PyMaterialXRenderOsl.

…d listings of modules in `README.md` files.

…d aliasing of `PyMaterialXFormat.readFromXmlFile()` function. The function is now exposed under its real name in the pybind11 bindings in C++.

Signed-off-by: Stefan Habel <19556655+StefanHabel@users.noreply.github.com>

either within the `MaterialX` Python package or as a standalone module. Signed-off-by: Stefan Habel <19556655+StefanHabel@users.noreply.github.com>

This PR adds support for generating Python API documentation in HTML format using Sphinx from the MaterialX Python that are built in the `lib/` directory. A new CMake build option named `MATERIALX_BUILD_PYTHON_DOCS` allows developers to turn generating Python API documentation on. When `MATERIALX_BUILD_PYTHON_DOCS` is set to `ON`, `MATERIALX_BUILD_PYTHON` is set to `ON` as well, ensuring we have Python modules for which to build the Python API docs. The core functionality of generating Python API documentation lives in a new directory named `documents/PythonAPI/`. It is controlled with a new `CMakeLists.txt` file in that directory, which defines a new target named `MaterialXDocsPython`, similar to the existing target `MaterialXDocs` that generates API documentation for the MaterialX C++ API. To facilitate the curation and addition of docstrings in the implementation files within `source/PyMaterialX/`, this PR adds a new helper macro named `PYMATERIALX_DOCSTRING` that allows developers of Python modules to define docstrings using the following pattern: ```cpp PYMATERIALX_DOCSTRING(R"docstring( ...markdown text here... )docstring"); ``` Revised docstrings for modules and classes are to be added in subsequent PRs separately. Documentation in markdown format from the existing `DeveloperGuide` is integrated into the new Python API documentation by way of symlinking the four main `.md` files into the `documents/PythonAPI/sources/` directory from which Sphinx generates the resulting HTML documentation. Warnings that are issued when generating the documentation via Sphinx are to be addressed in a separate PR for the markdown files: AcademySoftwareFoundation#2037 To build the docs from scratch on macOS, I've used the following build script, naming it `build.sh` in the `MaterialX` checkout directory: ```bash #!/usr/bin/env tcsh echo build.sh: Updating Git submodules... git submodule update --init --recursive # Create and activate a virtual environment for installing Python dependencies python3 -m venv /tmp/venv source /tmp/venv/bin/activate.csh echo build.sh: Installing dependencies... python3 -m pip install myst_parser # https://pypi.org/project/myst-parser/ echo build.sh: Making build directory and changing into it... mkdir build cd build echo build.sh: Configuring... cmake .. \ --fresh \ -DCMAKE_OSX_SYSROOT=/Library/Developer/CommandLineTools/SDKs/MacOSX15.0.sdk \ -DMATERIALX_BUILD_PYTHON=ON \ -DMATERIALX_BUILD_VIEWER=ON \ -DMATERIALX_BUILD_GRAPH_EDITOR=ON \ -DMATERIALX_BUILD_DOCS=ON \ -DMATERIALX_BUILD_PYTHON_DOCS=ON \ -DMATERIALX_BUILD_TESTS=ON \ && \ echo build.sh: Building... \ && \ cmake --build . -j 8 \ && \ echo build.sh: Building target MaterialXDocs... \ && \ cmake --build . --target MaterialXDocs \ && \ echo build.sh: Building target MaterialXDocsPython... \ && \ cmake --build . --target MaterialXDocsPython \ && \ afplay /System/Library/Sounds/Blow.aiff # Deactivate the virtual environment deactivate ``` The build output currently ends with the following messages: ```python The parsed MaterialX Python API consists of: * 11 modules * 48 functions * 139 classes * 1175 methods * 6 exception types WARNING: 48 functions look like they do not have docstrings yet. WARNING: 1019 methods look like they do not have docstrings yet. WARNING: 32 functions look like their parameters have not all been named using `py::arg()`. WARNING: 499 methods look like their parameters have not all been named using `py::arg()`. build succeeded, 168 warnings. The HTML pages are in .. [100%] Built target MaterialXDocsPython ``` Split from AcademySoftwareFoundation#1567. Update AcademySoftwareFoundation#342. Signed-off-by: Stefan Habel <19556655+StefanHabel@users.noreply.github.com>

This PR adds a docstring in markdown format to the `PyMaterialXCore` module. The docstring is defined in a macro named `PyMaterialXCore_DOCSTRING` that uses the new `PYMATERIALX_DOCSTRING` macro to allow us to place the first and last lines in lines by themselves, rather than starting the docstring contents immediately after the `R"docstring(` marker. The `PyMaterialXCore_DOCSTRING` macro is placed in a separate header file named `__doc__.md.h` which lives side-by-side with the `PyModule.cpp` file in which it is included. Split from AcademySoftwareFoundation#1567. Depends on AcademySoftwareFoundation#2038. Update AcademySoftwareFoundation#342. Signed-off-by: Stefan Habel <19556655+StefanHabel@users.noreply.github.com>

This PR adds a docstring in markdown format to the `PyMaterialXFormat` module. The docstring is defined in a macro named `PyMaterialXFormat_DOCSTRING` that uses the new `PYMATERIALX_DOCSTRING` macro that is introduced in AcademySoftwareFoundation#2038 to allow us to place the first and last lines in lines by themselves, rather than starting the docstring contents immediately after the `R"docstring(` marker. The `PyMaterialXFormat_DOCSTRING` macro is placed in a separate header file named `__doc__.md.h` which lives side-by-side with the `PyModule.cpp` file in which it is included. Note that the docstrings for individual classes, methods, and functions are to be added in separate PRs. Note that this PR also renames `readFromXmlFileBase()` to `readFromXmlFile()` allowing us to remove the alias from `python/MaterialX/main.py`. Split from AcademySoftwareFoundation#1567. Depends on AcademySoftwareFoundation#2038. Update AcademySoftwareFoundation#342. Signed-off-by: Stefan Habel <19556655+StefanHabel@users.noreply.github.com>

This PR adds docstrings in markdown format to the following modules: - `PyMaterialXGenGlsl` - `PyMaterialXGenMdl` - `PyMaterialXGenMsl` - `PyMaterialXGenOsl` - `PyMaterialXGenShader` The docstrings are defined in macros named `PyMaterialXGen*_DOCSTRING` that use the new `PYMATERIALX_DOCSTRING` macro that is introduced in AcademySoftwareFoundation#2038 to allow us to place the first and last lines in lines by themselves, rather than starting the docstring contents immediately after the `R"docstring(` marker. The `PyMaterialXGen*_DOCSTRING` macros are placed in separate header files named `__doc__.md.h` which live side-by-side with their corresponding `PyModule.cpp` file in which it is included. Note that the docstrings for individual classes, methods, and functions are to be added in separate PRs. Split from AcademySoftwareFoundation#1567. Depends on AcademySoftwareFoundation#2038. Update AcademySoftwareFoundation#342. Signed-off-by: Stefan Habel <19556655+StefanHabel@users.noreply.github.com>

This PR adds docstrings in markdown format to the following modules: - `PyMaterialXRender` - `PyMaterialXRenderGlsl` - `PyMaterialXRenderMsl` - `PyMaterialXRenderOsl` The docstrings are defined in macros named `PyMaterialXRender*_DOCSTRING` that use the new `PYMATERIALX_DOCSTRING` macro that is introduced in AcademySoftwareFoundation#2038 to allow us to place the first and last lines in lines by themselves, rather than starting the docstring contents immediately after the `R"docstring(` marker. The `PyMaterialXRender*_DOCSTRING` macros are placed in separate header files named `__doc__.md.h` which live side-by-side with their corresponding `PyModule.cpp` files in which they are included. Note that the docstrings for individual classes, methods, and functions are to be added in separate PRs. Split from AcademySoftwareFoundation#1567. Depends on AcademySoftwareFoundation#2038. Update AcademySoftwareFoundation#342. Signed-off-by: Stefan Habel <19556655+StefanHabel@users.noreply.github.com>

This PR adds support for generating Python API documentation in HTML format using Sphinx from the MaterialX Python that are built in the `lib/` directory. A new CMake build option named `MATERIALX_BUILD_PYTHON_DOCS` allows developers to turn generating Python API documentation on. When `MATERIALX_BUILD_PYTHON_DOCS` is set to `ON`, `MATERIALX_BUILD_PYTHON` is set to `ON` as well, ensuring we have Python modules for which to build the Python API docs. The core functionality of generating Python API documentation lives in a new directory named `documents/PythonAPI/`. It is controlled with a new `CMakeLists.txt` file in that directory, which defines a new target named `MaterialXDocsPython`, similar to the existing target `MaterialXDocs` that generates API documentation for the MaterialX C++ API. To facilitate the curation and addition of docstrings in the implementation files within `source/PyMaterialX/`, this PR adds a new helper macro named `PYMATERIALX_DOCSTRING` that allows developers of Python modules to define docstrings using the following pattern: ```cpp PYMATERIALX_DOCSTRING(R"docstring( ...markdown text here... )docstring"); ``` Revised docstrings for modules and classes are to be added in subsequent PRs separately. Documentation in markdown format from the existing `DeveloperGuide` is integrated into the new Python API documentation by way of symlinking the four main `.md` files into the `documents/PythonAPI/sources/` directory from which Sphinx generates the resulting HTML documentation. Warnings that are issued when generating the documentation via Sphinx are to be addressed in a separate PR for the markdown files: AcademySoftwareFoundation#2037 To build the docs from scratch on macOS, I've used the following build script, naming it `build.sh` in the `MaterialX` checkout directory: ```bash echo build.sh: Updating Git submodules... git submodule update --init --recursive python3 -m venv /tmp/venv source /tmp/venv/bin/activate.csh echo build.sh: Installing dependencies... python3 -m pip install myst_parser # https://pypi.org/project/myst-parser/ echo build.sh: Making build directory and changing into it... mkdir build cd build echo build.sh: Configuring... cmake .. \ --fresh \ -DCMAKE_OSX_SYSROOT=/Library/Developer/CommandLineTools/SDKs/MacOSX15.0.sdk \ -DMATERIALX_BUILD_PYTHON=ON \ -DMATERIALX_BUILD_VIEWER=ON \ -DMATERIALX_BUILD_GRAPH_EDITOR=ON \ -DMATERIALX_BUILD_DOCS=ON \ -DMATERIALX_BUILD_PYTHON_DOCS=ON \ -DMATERIALX_BUILD_TESTS=ON \ && \ echo build.sh: Building... \ && \ cmake --build . -j 8 \ && \ echo build.sh: Building target MaterialXDocs... \ && \ cmake --build . --target MaterialXDocs \ && \ echo build.sh: Building target MaterialXDocsPython... \ && \ cmake --build . --target MaterialXDocsPython \ && \ afplay /System/Library/Sounds/Blow.aiff deactivate ``` The build output currently ends with the following messages: ```python The parsed MaterialX Python API consists of: * 11 modules * 48 functions * 139 classes * 1175 methods * 6 exception types WARNING: 48 functions look like they do not have docstrings yet. WARNING: 1019 methods look like they do not have docstrings yet. WARNING: 32 functions look like their parameters have not all been named using `py::arg()`. WARNING: 499 methods look like their parameters have not all been named using `py::arg()`. build succeeded, 168 warnings. The HTML pages are in .. [100%] Built target MaterialXDocsPython ``` Split from AcademySoftwareFoundation#1567. Update AcademySoftwareFoundation#342. Signed-off-by: Stefan Habel <19556655+StefanHabel@users.noreply.github.com>

This PR adds a docstring in markdown format to the `PyMaterialXCore` module. The docstring is defined in a macro named `PyMaterialXCore_DOCSTRING` that uses the new `PYMATERIALX_DOCSTRING` macro to allow us to place the first and last lines in lines by themselves, rather than starting the docstring contents immediately after the `R"docstring(` marker. The `PyMaterialXCore_DOCSTRING` macro is placed in a separate header file named `__doc__.md.h` which lives side-by-side with the `PyModule.cpp` file in which it is included. Split from AcademySoftwareFoundation#1567. Depends on AcademySoftwareFoundation#2038. Update AcademySoftwareFoundation#342. Signed-off-by: Stefan Habel <19556655+StefanHabel@users.noreply.github.com>

This PR adds support for generating Python API documentation in HTML format using Sphinx from the MaterialX Python that are built in the `lib/` directory. A new CMake build option named `MATERIALX_BUILD_PYTHON_DOCS` allows developers to turn generating Python API documentation on. When `MATERIALX_BUILD_PYTHON_DOCS` is set to `ON`, `MATERIALX_BUILD_PYTHON` is set to `ON` as well, ensuring we have Python modules for which to build the Python API docs. The core functionality of generating Python API documentation lives in a new directory named `documents/PythonAPI/`. It is controlled with a new `CMakeLists.txt` file in that directory, which defines a new target named `MaterialXDocsPython`, similar to the existing target `MaterialXDocs` that generates API documentation for the MaterialX C++ API. To facilitate the curation and addition of docstrings in the implementation files within `source/PyMaterialX/`, this PR adds a new helper macro named `PYMATERIALX_DOCSTRING` that allows developers of Python modules to define docstrings using the following pattern: ```cpp PYMATERIALX_DOCSTRING(R"docstring( ...markdown text here... )docstring"); ``` Revised docstrings for modules and classes are to be added in subsequent PRs separately. Documentation in markdown format from the existing `DeveloperGuide` is integrated into the new Python API documentation by way of symlinking the four main `.md` files into the `documents/PythonAPI/sources/` directory from which Sphinx generates the resulting HTML documentation. Warnings that are issued when generating the documentation via Sphinx are to be addressed in a separate PR for the markdown files: AcademySoftwareFoundation#2037 To build the docs from scratch on macOS, I've used the following build script, naming it `build.sh` in the `MaterialX` checkout directory: ```bash echo build.sh: Updating Git submodules... git submodule update --init --recursive python3 -m venv /tmp/venv source /tmp/venv/bin/activate.csh echo build.sh: Installing dependencies... python3 -m pip install myst_parser # https://pypi.org/project/myst-parser/ echo build.sh: Making build directory and changing into it... mkdir build cd build echo build.sh: Configuring... cmake .. \ --fresh \ -DCMAKE_OSX_SYSROOT=/Library/Developer/CommandLineTools/SDKs/MacOSX15.0.sdk \ -DMATERIALX_BUILD_PYTHON=ON \ -DMATERIALX_BUILD_VIEWER=ON \ -DMATERIALX_BUILD_GRAPH_EDITOR=ON \ -DMATERIALX_BUILD_DOCS=ON \ -DMATERIALX_BUILD_PYTHON_DOCS=ON \ -DMATERIALX_BUILD_TESTS=ON \ && \ echo build.sh: Building... \ && \ cmake --build . -j 8 \ && \ echo build.sh: Building target MaterialXDocs... \ && \ cmake --build . --target MaterialXDocs \ && \ echo build.sh: Building target MaterialXDocsPython... \ && \ cmake --build . --target MaterialXDocsPython \ && \ afplay /System/Library/Sounds/Blow.aiff deactivate ``` The build output currently ends with the following messages: ```python The parsed MaterialX Python API consists of: * 11 modules * 48 functions * 139 classes * 1175 methods * 6 exception types WARNING: 48 functions look like they do not have docstrings yet. WARNING: 1019 methods look like they do not have docstrings yet. WARNING: 32 functions look like their parameters have not all been named using `py::arg()`. WARNING: 499 methods look like their parameters have not all been named using `py::arg()`. build succeeded, 168 warnings. The HTML pages are in .. [100%] Built target MaterialXDocsPython ``` Split from AcademySoftwareFoundation#1567. Update AcademySoftwareFoundation#342. Signed-off-by: Stefan Habel <19556655+StefanHabel@users.noreply.github.com>

jstone-lucasfilm · 2024-10-03T15:37:47Z

Thanks for getting this started, @StefanHabel, and I believe we can close out this earlier PR in favor of your recent work in #2038.

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("<name>").doc() = ...` syntax so that this patch only adds new lines, rather than modifying existing lines. Using `:see:` fields to link to the corresponding C++ API docs page. Demo of generated HTML page available here: https://stefanhabel.github.io/generated/PyMaterialXCore.html Split from AcademySoftwareFoundation#1567. Update AcademySoftwareFoundation#342. Signed-off-by: Stefan Habel <19556655+StefanHabel@users.noreply.github.com>

Split from AcademySoftwareFoundation#1567. Update AcademySoftwareFoundation#342. Signed-off-by: Stefan Habel <19556655+StefanHabel@users.noreply.github.com>

Similar to AcademySoftwareFoundation#2051 and AcademySoftwareFoundation#2061. Split from AcademySoftwareFoundation#1567. Update AcademySoftwareFoundation#342. Signed-off-by: Stefan Habel <19556655+StefanHabel@users.noreply.github.com>

Similar to AcademySoftwareFoundation#2051 and AcademySoftwareFoundation#2061 and AcademySoftwareFoundation#2063. Split from AcademySoftwareFoundation#1567. Update AcademySoftwareFoundation#342. Signed-off-by: Stefan Habel <19556655+StefanHabel@users.noreply.github.com>

Similar to AcademySoftwareFoundation#2051, AcademySoftwareFoundation#2061, AcademySoftwareFoundation#2063, and AcademySoftwareFoundation#2064. Split from AcademySoftwareFoundation#1567. Update AcademySoftwareFoundation#342. Signed-off-by: Stefan Habel <19556655+StefanHabel@users.noreply.github.com>

Similar to AcademySoftwareFoundation#2051, AcademySoftwareFoundation#2061, AcademySoftwareFoundation#2063, AcademySoftwareFoundation#2064, and AcademySoftwareFoundation#2065. Also fixing a couple of typos in Metal header files. Split from AcademySoftwareFoundation#1567. Update AcademySoftwareFoundation#342. Signed-off-by: Stefan Habel <19556655+StefanHabel@users.noreply.github.com>

StefanHabel marked this pull request as draft October 13, 2023 01:46

kwokcb reviewed Oct 13, 2023

View reviewed changes

jstone-lucasfilm changed the title ~~Update #342 Sphinx Python Documentation.~~ Sphinx Python Documentation Oct 13, 2023

jstone-lucasfilm reviewed Oct 13, 2023

View reviewed changes

cmake/modules/FindSphinx.cmake Show resolved Hide resolved

StefanHabel force-pushed the #342-Sphinx-Python-Documentation branch from 8a66335 to 9e4c1ff Compare October 16, 2023 04:54

StefanHabel force-pushed the #342-Sphinx-Python-Documentation branch from 9e4c1ff to bef6e1f Compare October 18, 2023 05:46

StefanHabel added 22 commits October 17, 2023 23:16

Sphinx Python Documentation (AcademySoftwareFoundation#1567) - Added …

9d4b492

…MATERIALX_BUILD_PYTHON_DOCS build option.

Sphinx Python Documentation (AcademySoftwareFoundation#1567) - Revise…

6a5da31

…d `index.rst`. Changed index page title, added introduction text, and changed the order of Python modules, to reflect the order in which support for the different shading languages was added to MaterialX.

Sphinx Python Documentation (AcademySoftwareFoundation#1567) - Fixed …

c983b87

…a couple of typos in header files.

Sphinx Python Documentation (AcademySoftwareFoundation#1567) - Added …

3567610

…define to produce detailed error messages in pybind11.

Sphinx Python Documentation (AcademySoftwareFoundation#1567) - Added …

abc2edb

…docstrings to PyMaterialXCore.

Sphinx Python Documentation (AcademySoftwareFoundation#1567) - Added …

133a0b4

…docstrings to PyMaterialXFormat.

Sphinx Python Documentation (AcademySoftwareFoundation#1567) - Added …

67bb241

…docstrings to PyMaterialXGenGlsl.

Sphinx Python Documentation (AcademySoftwareFoundation#1567) - Added …

e715c0f

…docstrings to PyMaterialXGenMdl.

Sphinx Python Documentation (AcademySoftwareFoundation#1567) - Added …

6a9d8e5

…docstrings to PyMaterialXGenMsl.

Sphinx Python Documentation (AcademySoftwareFoundation#1567) - Added …

2c04542

…docstrings to PyMaterialXGenOsl.

Sphinx Python Documentation (AcademySoftwareFoundation#1567) - Added …

8790578

…docstrings to PyMaterialXGenShader.

Sphinx Python Documentation (AcademySoftwareFoundation#1567) - Added …

0439c07

…docstrings to PyMaterialXRender.

Sphinx Python Documentation (AcademySoftwareFoundation#1567) - Added …

1e745bd

…docstrings to PyMaterialXRenderGlsl.

Sphinx Python Documentation (AcademySoftwareFoundation#1567) - Added …

4c11bde

…docstrings to PyMaterialXRenderMsl.

Sphinx Python Documentation (AcademySoftwareFoundation#1567) - Added …

9d73ddc

…docstrings to PyMaterialXRenderOsl.

Sphinx Python Documentation (AcademySoftwareFoundation#1567) - Update…

0e1e502

…d listings of modules in `README.md` files.

Sphinx Python Documentation (AcademySoftwareFoundation#1567) - Remove…

805f13c

…d aliasing of `PyMaterialXFormat.readFromXmlFile()` function. The function is now exposed under its real name in the pybind11 bindings in C++.

Fixed a couple of typos in MaterialXGenShader/Util.h.

c0d65ed

Signed-off-by: Stefan Habel <19556655+StefanHabel@users.noreply.github.com>

Added PYMATERIALX_IMPORT_MODULE macro to import a PyMaterialX module

ab6860b

either within the `MaterialX` Python package or as a standalone module. Signed-off-by: Stefan Habel <19556655+StefanHabel@users.noreply.github.com>

StefanHabel mentioned this pull request Sep 29, 2024

Updated markdown documentation files #2037

Merged

StefanHabel mentioned this pull request Sep 30, 2024

Generating Python API docs #2038

Open

StefanHabel mentioned this pull request Sep 30, 2024

Improvements to PyMaterialX docstrings #2039

Merged

StefanHabel mentioned this pull request Sep 30, 2024

Adding a docstring for PyMaterialXFormat. #2040

Closed

StefanHabel mentioned this pull request Sep 30, 2024

Adding docstrings for PyMaterialXGen*. #2041

Closed

StefanHabel mentioned this pull request Sep 30, 2024

Adding docstrings for PyMaterialXRender*. #2042

Closed

jstone-lucasfilm closed this Oct 3, 2024

StefanHabel mentioned this pull request Oct 7, 2024

Docstrings for PyMaterialXCore classes. #2051

Open

StefanHabel mentioned this pull request Oct 13, 2024

Docstrings for PyMaterialXFormat classes. #2061

Open

StefanHabel mentioned this pull request Oct 13, 2024

Docstrings for PyMaterialXGenShader classes. #2063

Open

StefanHabel mentioned this pull request Oct 13, 2024

Docstrings for PyMaterialXGen* classes. #2064

Open

StefanHabel mentioned this pull request Oct 13, 2024

Docstrings for PyMaterialXRender classes. #2065

Open

StefanHabel mentioned this pull request Oct 14, 2024

Docstrings for PyMaterialXRender* classes. #2066

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Sphinx Python Documentation #1567

Sphinx Python Documentation #1567

StefanHabel commented Oct 13, 2023 •

edited

Loading

linux-foundation-easycla bot commented Oct 13, 2023 •

edited

Loading

kwokcb left a comment

kwokcb Oct 13, 2023

StefanHabel Oct 21, 2023

StefanHabel Sep 29, 2024

jstone-lucasfilm commented Oct 3, 2024

Sphinx Python Documentation #1567

Sphinx Python Documentation #1567

Conversation

StefanHabel commented Oct 13, 2023 • edited Loading

linux-foundation-easycla bot commented Oct 13, 2023 • edited Loading

kwokcb left a comment

Choose a reason for hiding this comment

kwokcb Oct 13, 2023

Choose a reason for hiding this comment

StefanHabel Oct 21, 2023

Choose a reason for hiding this comment

StefanHabel Sep 29, 2024

Choose a reason for hiding this comment

jstone-lucasfilm commented Oct 3, 2024

StefanHabel commented Oct 13, 2023 •

edited

Loading

linux-foundation-easycla bot commented Oct 13, 2023 •

edited

Loading