-
Notifications
You must be signed in to change notification settings - Fork 351
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.
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
Sphinx Python Documentation #1567
Sphinx Python Documentation #1567
Commits on Oct 18, 2023
-
Update AcademySoftwareFoundation#342 Sphinx Python Documentation.
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>
Configuration menu - View commit details
-
Copy full SHA for bef6e1f - Browse repository at this point
Copy the full SHA bef6e1fView commit details -
Sphinx Python Documentation (AcademySoftwareFoundation#1567) - Added …
…MATERIALX_BUILD_PYTHON_DOCS build option.
Configuration menu - View commit details
-
Copy full SHA for 9d4b492 - Browse repository at this point
Copy the full SHA 9d4b492View commit details -
Sphinx Python Documentation (AcademySoftwareFoundation#1567) - Update…
…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.
Configuration menu - View commit details
-
Copy full SHA for e129d65 - Browse repository at this point
Copy the full SHA e129d65View commit details -
Sphinx Python Documentation (AcademySoftwareFoundation#1567) - Revise…
…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.
Configuration menu - View commit details
-
Copy full SHA for 6a5da31 - Browse repository at this point
Copy the full SHA 6a5da31View commit details -
Sphinx Python Documentation (AcademySoftwareFoundation#1567) - Resolv…
…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.
Configuration menu - View commit details
-
Copy full SHA for e1113ea - Browse repository at this point
Copy the full SHA e1113eaView commit details -
Sphinx Python Documentation (AcademySoftwareFoundation#1567) - Tweake…
…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
Configuration menu - View commit details
-
Copy full SHA for e4382bb - Browse repository at this point
Copy the full SHA e4382bbView commit details -
Sphinx Python Documentation (AcademySoftwareFoundation#1567) - Fixed …
…a couple of typos in header files.
Configuration menu - View commit details
-
Copy full SHA for c983b87 - Browse repository at this point
Copy the full SHA c983b87View commit details -
Sphinx Python Documentation (AcademySoftwareFoundation#1567) - Added …
…define to produce detailed error messages in pybind11.
Configuration menu - View commit details
-
Copy full SHA for 3567610 - Browse repository at this point
Copy the full SHA 3567610View commit details -
Sphinx Python Documentation (AcademySoftwareFoundation#1567) - Added …
…docstrings to PyMaterialXCore.
Configuration menu - View commit details
-
Copy full SHA for abc2edb - Browse repository at this point
Copy the full SHA abc2edbView commit details -
Sphinx Python Documentation (AcademySoftwareFoundation#1567) - Added …
…docstrings to PyMaterialXFormat.
Configuration menu - View commit details
-
Copy full SHA for 133a0b4 - Browse repository at this point
Copy the full SHA 133a0b4View commit details -
Sphinx Python Documentation (AcademySoftwareFoundation#1567) - Added …
…docstrings to PyMaterialXGenGlsl.
Configuration menu - View commit details
-
Copy full SHA for 67bb241 - Browse repository at this point
Copy the full SHA 67bb241View commit details -
Sphinx Python Documentation (AcademySoftwareFoundation#1567) - Added …
…docstrings to PyMaterialXGenMdl.
Configuration menu - View commit details
-
Copy full SHA for e715c0f - Browse repository at this point
Copy the full SHA e715c0fView commit details -
Sphinx Python Documentation (AcademySoftwareFoundation#1567) - Added …
…docstrings to PyMaterialXGenMsl.
Configuration menu - View commit details
-
Copy full SHA for 6a9d8e5 - Browse repository at this point
Copy the full SHA 6a9d8e5View commit details -
Sphinx Python Documentation (AcademySoftwareFoundation#1567) - Added …
…docstrings to PyMaterialXGenOsl.
Configuration menu - View commit details
-
Copy full SHA for 2c04542 - Browse repository at this point
Copy the full SHA 2c04542View commit details -
Sphinx Python Documentation (AcademySoftwareFoundation#1567) - Added …
…docstrings to PyMaterialXGenShader.
Configuration menu - View commit details
-
Copy full SHA for 8790578 - Browse repository at this point
Copy the full SHA 8790578View commit details -
Sphinx Python Documentation (AcademySoftwareFoundation#1567) - Added …
…docstrings to PyMaterialXRender.
Configuration menu - View commit details
-
Copy full SHA for 0439c07 - Browse repository at this point
Copy the full SHA 0439c07View commit details -
Sphinx Python Documentation (AcademySoftwareFoundation#1567) - Added …
…docstrings to PyMaterialXRenderGlsl.
Configuration menu - View commit details
-
Copy full SHA for 1e745bd - Browse repository at this point
Copy the full SHA 1e745bdView commit details -
Sphinx Python Documentation (AcademySoftwareFoundation#1567) - Added …
…docstrings to PyMaterialXRenderMsl.
Configuration menu - View commit details
-
Copy full SHA for 4c11bde - Browse repository at this point
Copy the full SHA 4c11bdeView commit details -
Sphinx Python Documentation (AcademySoftwareFoundation#1567) - Added …
…docstrings to PyMaterialXRenderOsl.
Configuration menu - View commit details
-
Copy full SHA for 9d73ddc - Browse repository at this point
Copy the full SHA 9d73ddcView commit details -
Sphinx Python Documentation (AcademySoftwareFoundation#1567) - Update…
…d listings of modules in `README.md` files.
Configuration menu - View commit details
-
Copy full SHA for 0e1e502 - Browse repository at this point
Copy the full SHA 0e1e502View commit details -
Sphinx Python Documentation (AcademySoftwareFoundation#1567) - Remove…
…d aliasing of `PyMaterialXFormat.readFromXmlFile()` function. The function is now exposed under its real name in the pybind11 bindings in C++.
Configuration menu - View commit details
-
Copy full SHA for 805f13c - Browse repository at this point
Copy the full SHA 805f13cView commit details
Commits on Oct 20, 2023
-
Fixed a couple of typos in
MaterialXGenShader/Util.h
.Signed-off-by: Stefan Habel <19556655+StefanHabel@users.noreply.github.com>
Configuration menu - View commit details
-
Copy full SHA for c0d65ed - Browse repository at this point
Copy the full SHA c0d65edView commit details -
Added
PYMATERIALX_IMPORT_MODULE
macro to import a PyMaterialX moduleeither within the `MaterialX` Python package or as a standalone module. Signed-off-by: Stefan Habel <19556655+StefanHabel@users.noreply.github.com>
Configuration menu - View commit details
-
Copy full SHA for ab6860b - Browse repository at this point
Copy the full SHA ab6860bView commit details -
Added
PYMATERIALX_DOCSTRING
macro to erase the first newline characterfrom docstrings. This allows us to start docstrings on a new line, while keeping the help text that `help()` in a `python` session provides clean. Also added docstrings to a couple more functions. Signed-off-by: Stefan Habel <19556655+StefanHabel@users.noreply.github.com>
Configuration menu - View commit details
-
Copy full SHA for 26a972f - Browse repository at this point
Copy the full SHA 26a972fView commit details -
Added warnings and statistics to the Sphinx generation.
The warnings give us an idea of how much work is left to be done: ``` The MaterialX Python API consists of: * 11 modules * 48 functions * 139 classes * 1176 methods * 6 exception types WARNING: 475 methods look like their parameters have not all been named using `py::arg()`: ``` Signed-off-by: Stefan Habel <19556655+StefanHabel@users.noreply.github.com>
Configuration menu - View commit details
-
Copy full SHA for b8eecc0 - Browse repository at this point
Copy the full SHA b8eecc0View commit details
Commits on Oct 21, 2023
-
Added section describing the MaterialX Python API. (AcademySoftwareFo…
…undation#1567) ...to mention the `MaterialX` Python package, and the way it's typically aliased as `mx` upon `import`. Also removed the paragraph about the MaterialX.org site, as it seemed unnecessary. Also added a link to the auto-generated alphabetical index to the TOC. Signed-off-by: Stefan Habel <19556655+StefanHabel@users.noreply.github.com>
Configuration menu - View commit details
-
Copy full SHA for bf427e4 - Browse repository at this point
Copy the full SHA bf427e4View commit details -
Added links to source folders on GitHub to module template. (AcademyS…
…oftwareFoundation#1567) Signed-off-by: Stefan Habel <19556655+StefanHabel@users.noreply.github.com>
Configuration menu - View commit details
-
Copy full SHA for fbe2947 - Browse repository at this point
Copy the full SHA fbe2947View commit details -
Extended build checks to warn about undocumented functions and method…
…s. (AcademySoftwareFoundation#1567) For example: ``` WARNING: 1141 methods look like they do not have docstrings yet. ``` Signed-off-by: Stefan Habel <19556655+StefanHabel@users.noreply.github.com>
Configuration menu - View commit details
-
Copy full SHA for f064a22 - Browse repository at this point
Copy the full SHA f064a22View commit details -
Tweaked custom style sheet regarding highlighting and indexes. (Acade…
…mySoftwareFoundation#1567) Signed-off-by: Stefan Habel <19556655+StefanHabel@users.noreply.github.com>
Configuration menu - View commit details
-
Copy full SHA for d30276b - Browse repository at this point
Copy the full SHA d30276bView commit details -
More docstrings for methods in the
Element
class. (AcademySoftwareF……oundation#1567) Signed-off-by: Stefan Habel <19556655+StefanHabel@users.noreply.github.com>
Configuration menu - View commit details
-
Copy full SHA for 86030d0 - Browse repository at this point
Copy the full SHA 86030d0View commit details -
Revised example code in utility functions of
PyMaterialXCore
. (Acad……emySoftwareFoundation#1567) Signed-off-by: Stefan Habel <19556655+StefanHabel@users.noreply.github.com>
Configuration menu - View commit details
-
Copy full SHA for 90c78d4 - Browse repository at this point
Copy the full SHA 90c78d4View commit details
Commits on Oct 25, 2023
-
Merge branch 'main' into AcademySoftwareFoundation#342-Sphinx-Python-…
…Documentation Signed-off-by: Jonathan Stone <jstone@lucasfilm.com>
Configuration menu - View commit details
-
Copy full SHA for 37f1ef5 - Browse repository at this point
Copy the full SHA 37f1ef5View commit details
Commits on Oct 31, 2023
-
Extended docstrings of
PyMaterialXCore
andPyMaterialXFormat
. (Ac……ademySoftwareFoundation#1567) Mentioning that all functions and classes from those modules are available in the top-level `MaterialX` Python package. Also removed the repeated `import` statements from example code in utility functions of `PyMaterialXCore`. Also wrapped more module docstrings in `PYMATERIALX_DOCSTRING()`. Signed-off-by: Stefan Habel <19556655+StefanHabel@users.noreply.github.com>
Configuration menu - View commit details
-
Copy full SHA for aed7f8f - Browse repository at this point
Copy the full SHA aed7f8fView commit details -
Tweaked module template to clarify module source links. (AcademySoftw…
…areFoundation#1567) Signed-off-by: Stefan Habel <19556655+StefanHabel@users.noreply.github.com>
Configuration menu - View commit details
-
Copy full SHA for 052f38e - Browse repository at this point
Copy the full SHA 052f38eView commit details -
Fixed a typo in messages at the end of the Sphinx build. (AcademySoft…
…wareFoundation#1567) Signed-off-by: Stefan Habel <19556655+StefanHabel@users.noreply.github.com>
Configuration menu - View commit details
-
Copy full SHA for 939c996 - Browse repository at this point
Copy the full SHA 939c996View commit details -
Exposed
Element.getChild()
in the Python API docs. (AcademySoftware……Foundation#1567) ...by renaming `Element._getChild()` to `Element.getChild()`. Signed-off-by: Stefan Habel <19556655+StefanHabel@users.noreply.github.com>
Configuration menu - View commit details
-
Copy full SHA for 77b5944 - Browse repository at this point
Copy the full SHA 77b5944View commit details -
More fixes in header files in MaterialXCore. (AcademySoftwareFoundati…
…on#1567) Signed-off-by: Stefan Habel <19556655+StefanHabel@users.noreply.github.com>
Configuration menu - View commit details
-
Copy full SHA for be2db5e - Browse repository at this point
Copy the full SHA be2db5eView commit details -
More fixes in header files. (AcademySoftwareFoundation#1567)
Signed-off-by: Stefan Habel <19556655+StefanHabel@users.noreply.github.com>
Configuration menu - View commit details
-
Copy full SHA for 71bd3fd - Browse repository at this point
Copy the full SHA 71bd3fdView commit details -
Tweaked
PYMATERIALX_DOCSTRING
macro to also trim the last character. (AcademySoftwareFoundation#1567) Signed-off-by: Stefan Habel <19556655+StefanHabel@users.noreply.github.com>
Configuration menu - View commit details
-
Copy full SHA for f7bea44 - Browse repository at this point
Copy the full SHA f7bea44View commit details -
Tweaked contents of index page. (AcademySoftwareFoundation#1567)
Signed-off-by: Stefan Habel <19556655+StefanHabel@users.noreply.github.com>
Configuration menu - View commit details
-
Copy full SHA for e66a3f5 - Browse repository at this point
Copy the full SHA e66a3f5View commit details -
Minor tweak of Jinja template for module pages. (AcademySoftwareFound…
…ation#1567) Signed-off-by: Stefan Habel <19556655+StefanHabel@users.noreply.github.com>
Configuration menu - View commit details
-
Copy full SHA for 28fd863 - Browse repository at this point
Copy the full SHA 28fd863View commit details -
Support for listing properties and attributes of classes separately. (A…
…cademySoftwareFoundation#1567) Signed-off-by: Stefan Habel <19556655+StefanHabel@users.noreply.github.com>
Configuration menu - View commit details
-
Copy full SHA for 74872ea - Browse repository at this point
Copy the full SHA 74872eaView commit details -
Tweaked style sheet. (AcademySoftwareFoundation#1567)
Signed-off-by: Stefan Habel <19556655+StefanHabel@users.noreply.github.com>
Configuration menu - View commit details
-
Copy full SHA for 572089b - Browse repository at this point
Copy the full SHA 572089bView commit details -
Simplified detection of class names by defining a handler for 'autodo…
…c-process-bases'. (AcademySoftwareFoundation#1567) Signed-off-by: Stefan Habel <19556655+StefanHabel@users.noreply.github.com>
Configuration menu - View commit details
-
Copy full SHA for 513ef90 - Browse repository at this point
Copy the full SHA 513ef90View commit details -
Docstrings for PyMaterialXCore. (AcademySoftwareFoundation#1567)
Signed-off-by: Stefan Habel <19556655+StefanHabel@users.noreply.github.com>
Configuration menu - View commit details
-
Copy full SHA for c9a2469 - Browse repository at this point
Copy the full SHA c9a2469View commit details -
Docstrings for PyMaterialXFormat. (AcademySoftwareFoundation#1567)
Signed-off-by: Stefan Habel <19556655+StefanHabel@users.noreply.github.com>
Configuration menu - View commit details
-
Copy full SHA for 21eecdd - Browse repository at this point
Copy the full SHA 21eecddView commit details -
Docstrings for PyMaterialXGenGlsl. (AcademySoftwareFoundation#1567)
Signed-off-by: Stefan Habel <19556655+StefanHabel@users.noreply.github.com>
Configuration menu - View commit details
-
Copy full SHA for 40079f1 - Browse repository at this point
Copy the full SHA 40079f1View commit details -
Docstrings for PyMaterialXGenMdl. (AcademySoftwareFoundation#1567)
Signed-off-by: Stefan Habel <19556655+StefanHabel@users.noreply.github.com>
Configuration menu - View commit details
-
Copy full SHA for dfa106a - Browse repository at this point
Copy the full SHA dfa106aView commit details -
Docstrings for PyMaterialXGenMsl. (AcademySoftwareFoundation#1567)
Signed-off-by: Stefan Habel <19556655+StefanHabel@users.noreply.github.com>
Configuration menu - View commit details
-
Copy full SHA for f62be3a - Browse repository at this point
Copy the full SHA f62be3aView commit details -
Docstrings for PyMaterialXGenOsl. (AcademySoftwareFoundation#1567)
Signed-off-by: Stefan Habel <19556655+StefanHabel@users.noreply.github.com>
Configuration menu - View commit details
-
Copy full SHA for 77ca69c - Browse repository at this point
Copy the full SHA 77ca69cView commit details -
Docstrings for PyMaterialXGenShader. (AcademySoftwareFoundation#1567)
Signed-off-by: Stefan Habel <19556655+StefanHabel@users.noreply.github.com>
Configuration menu - View commit details
-
Copy full SHA for 6253abc - Browse repository at this point
Copy the full SHA 6253abcView commit details -
Docstrings for PyMaterialXRender. (AcademySoftwareFoundation#1567)
Signed-off-by: Stefan Habel <19556655+StefanHabel@users.noreply.github.com>
Configuration menu - View commit details
-
Copy full SHA for c1b31c0 - Browse repository at this point
Copy the full SHA c1b31c0View commit details -
Docstrings for PyMaterialXRenderGlsl. (AcademySoftwareFoundation#1567)
Signed-off-by: Stefan Habel <19556655+StefanHabel@users.noreply.github.com>
Configuration menu - View commit details
-
Copy full SHA for 0ca9f23 - Browse repository at this point
Copy the full SHA 0ca9f23View commit details -
ocstrings for PyMaterialXRenderMsl. (AcademySoftwareFoundation#1567)
Signed-off-by: Stefan Habel <19556655+StefanHabel@users.noreply.github.com>
Configuration menu - View commit details
-
Copy full SHA for f73acc4 - Browse repository at this point
Copy the full SHA f73acc4View commit details -
Docstrings for PyMaterialXRenderOsl. (AcademySoftwareFoundation#1567)
Signed-off-by: Stefan Habel <19556655+StefanHabel@users.noreply.github.com>
Configuration menu - View commit details
-
Copy full SHA for b589282 - Browse repository at this point
Copy the full SHA b589282View commit details