Skip to content

Commit

Permalink
Sphinx Python Documentation (#1567) - Revised index.rst.
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
StefanHabel committed Oct 18, 2023
1 parent e129d65 commit 6a5da31
Showing 1 changed file with 23 additions and 5 deletions.
28 changes: 23 additions & 5 deletions documents/DeveloperGuide/index.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,23 @@
MaterialX Developer Guide
=========================
MaterialX Python API Documentation
==================================

The MaterialX Python API provides Python bindings for the
`MaterialX C++ API <https://materialx.org/docs/api/>`_ .

MaterialX is an open standard for representing rich material and look-development
content in computer graphics, enabling its platform-independent description and
exchange across applications and renderers. Launched at `Industrial Light & Magic
<https://www.ilm.com/>`_ in 2012, MaterialX has been a key technology in their
feature films and real-time experiences since *Star Wars: The Force Awakens*
and *Millennium Falcon: Smugglers Run*. The project was released as open source
in 2017, with companies including Sony Pictures Imageworks, Pixar, Autodesk,
Adobe, and SideFX contributing to its ongoing development. In 2021, MaterialX
became the seventh hosted project of the `Academy Software Foundation
<https://www.aswf.io/>`_ .

General information about MaterialX, announcements, events, third-party support,
and contributing to MaterialX is available at
`MaterialX.org <https://materialx.org/>`_ .

.. toctree::
:maxdepth: 1
Expand All @@ -19,15 +37,15 @@ MaterialX Python Modules

PyMaterialXCore
PyMaterialXFormat
PyMaterialXGenShader
PyMaterialXGenGlsl
PyMaterialXGenOsl
PyMaterialXGenMdl
PyMaterialXGenMsl
PyMaterialXGenOsl
PyMaterialXGenShader
PyMaterialXRender
PyMaterialXRenderGlsl
PyMaterialXRenderMsl
PyMaterialXRenderOsl
PyMaterialXRenderMsl


Import Order Dependencies
Expand Down

0 comments on commit 6a5da31

Please sign in to comment.