Docstrings for PyMaterialXCore classes. #2051
Open
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 toPyMaterialXCore.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.The docstrings can be retrieved using
help()
, e.g.$ python3 -c 'import PyMaterialXCore; help(PyMaterialXCore.NodeDef)'
Demo of generated HTML page available here:
https://stefanhabel.github.io/generated/PyMaterialXCore.html
Here's how the above docstring of the
NodeDef
class appears in the Python API documentation:https://stefanhabel.github.io/generated/PyMaterialXCore.NodeDef.html
Split from #1567.
Update #342.