Sphinx Python Documentation (#1567) - Added docstrings to PyMaterialX…

…GenOsl.
AcademySoftwareFoundation · Oct 18, 2023 · 2c04542 · 2c04542
1 parent 6a9d8e5
commit 2c04542
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 2 deletions.
diff --git a/source/PyMaterialX/PyMaterialXGenOsl/PyModule.cpp b/source/PyMaterialX/PyMaterialXGenOsl/PyModule.cpp
@@ -11,7 +11,27 @@ void bindPyOslShaderGenerator(py::module& mod);
 
 PYBIND11_MODULE(PyMaterialXGenOsl, mod)
 {
-    mod.doc() = "Shader generation using Open Shading Language";
+    mod.doc() = R"docstring(
+    Shader generation using Open Shading Language.
+
+    :see: https://openshadinglanguage.org/
+    :see: https://open-shading-language.readthedocs.io/
+
+    OSL Shader Generation Classes
+    -----------------------------
+
+    **Class Hierarchy**
+
+    * `PyMaterialXGenShader.ShaderGenerator`
+        * `OslShaderGenerator`
+
+    **Class Index**
+
+    .. autosummary::
+        :toctree: osl-shader-generators
+
+        OslShaderGenerator
+)docstring";
 
     // PyMaterialXGenOsl depends on types defined in PyMaterialXGenShader
     pybind11::module::import("PyMaterialXGenShader");

diff --git a/source/PyMaterialX/PyMaterialXGenOsl/PyOslShaderGenerator.cpp b/source/PyMaterialX/PyMaterialXGenOsl/PyOslShaderGenerator.cpp
@@ -24,5 +24,11 @@ void bindPyOslShaderGenerator(py::module& mod)
         .def_static("create", &mx::OslShaderGenerator::create)
         .def(py::init<>())
         .def("getTarget", &mx::OslShaderGenerator::getTarget)
-        .def("generate", &mx::OslShaderGenerator::generate);
+        .def("generate", &mx::OslShaderGenerator::generate)
+        .doc() = R"docstring(
+    Base class for OSL (Open Shading Language) shader generators.
+    A generator for a specific OSL target should be derived from this class.
+
+    :see: https://materialx.org/docs/api/class_osl_shader_generator.html
+)docstring";
 }