Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Docstrings for PyMaterialXCore classes. #2051

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Docstrings for PyMaterialXCore classes. #2051

wants to merge 1 commit into from

Commits on Oct 7, 2024

  1. Docstrings for PyMaterialXCore classes. 

    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 <[email protected]>
    @StefanHabel
    StefanHabel committed Oct 7, 2024
    Configuration menu
    Copy the full SHA
    1100bf0 View commit details
    Browse the repository at this point in the history