Code

Sphinx Python Documentation#1567

Code

Closed

StefanHabel wants to merge 55 commits intoAcademySoftwareFoundation:mainAcademySoftwareFoundation/MaterialX:mainfrom StefanHabel:#342-Sphinx-Python-DocumentationStefanHabel/MaterialX:#342-Sphinx-Python-DocumentationCopy head branch name to clipboard

+12,681-1,678

Commits

Commits on Oct 18, 2023

• Update AcademySoftwareFoundation#342 Sphinx Python Documentation.

  Show description for bef6e1f
  StefanHabel

  committed
  bef6e1f

  Copy full SHA for bef6e1f

• Sphinx Python Documentation (AcademySoftwareFoundation#1567) - Added MATERIALX_BUILD_PYTHON_DOCS build option.

  StefanHabel

  committed
  9d4b492

  Copy full SHA for 9d4b492

• Sphinx Python Documentation (AcademySoftwareFoundation#1567) - Updated Markdown files to use absolute URLs.

  Show description for e129d65
  StefanHabel

  committed
  e129d65

  Copy full SHA for e129d65

• Sphinx Python Documentation (AcademySoftwareFoundation#1567) - Revised index.rst.

  Show description for 6a5da31
  StefanHabel

  committed
  6a5da31

  Copy full SHA for 6a5da31

• Sphinx Python Documentation (AcademySoftwareFoundation#1567) - Resolved import order dependency issue.

  Show description for e1113ea
  StefanHabel

  committed
  e1113ea

  Copy full SHA for e1113ea

• Sphinx Python Documentation (AcademySoftwareFoundation#1567) - Tweaked Sphinx configuration.

  Show description for e4382bb
  StefanHabel

  committed
  e4382bb

  Copy full SHA for e4382bb

• Sphinx Python Documentation (AcademySoftwareFoundation#1567) - Fixed a couple of typos in header files.

  StefanHabel

  committed
  c983b87

  Copy full SHA for c983b87

• Sphinx Python Documentation (AcademySoftwareFoundation#1567) - Added define to produce detailed error messages in pybind11.

  StefanHabel

  committed
  3567610

  Copy full SHA for 3567610

• Sphinx Python Documentation (AcademySoftwareFoundation#1567) - Added docstrings to PyMaterialXCore.

  StefanHabel

  committed
  abc2edb

  Copy full SHA for abc2edb

• Sphinx Python Documentation (AcademySoftwareFoundation#1567) - Added docstrings to PyMaterialXFormat.

  StefanHabel

  committed
  133a0b4

  Copy full SHA for 133a0b4

• Sphinx Python Documentation (AcademySoftwareFoundation#1567) - Added docstrings to PyMaterialXGenGlsl.

  StefanHabel

  committed
  67bb241

  Copy full SHA for 67bb241

• Sphinx Python Documentation (AcademySoftwareFoundation#1567) - Added docstrings to PyMaterialXGenMdl.

  StefanHabel

  committed
  e715c0f

  Copy full SHA for e715c0f

• Sphinx Python Documentation (AcademySoftwareFoundation#1567) - Added docstrings to PyMaterialXGenMsl.

  StefanHabel

  committed
  6a9d8e5

  Copy full SHA for 6a9d8e5

• Sphinx Python Documentation (AcademySoftwareFoundation#1567) - Added docstrings to PyMaterialXGenOsl.

  StefanHabel

  committed
  2c04542

  Copy full SHA for 2c04542

• Sphinx Python Documentation (AcademySoftwareFoundation#1567) - Added docstrings to PyMaterialXGenShader.

  StefanHabel

  committed
  8790578

  Copy full SHA for 8790578

• Sphinx Python Documentation (AcademySoftwareFoundation#1567) - Added docstrings to PyMaterialXRender.

  StefanHabel

  committed
  0439c07

  Copy full SHA for 0439c07

• Sphinx Python Documentation (AcademySoftwareFoundation#1567) - Added docstrings to PyMaterialXRenderGlsl.

  StefanHabel

  committed
  1e745bd

  Copy full SHA for 1e745bd

• Sphinx Python Documentation (AcademySoftwareFoundation#1567) - Added docstrings to PyMaterialXRenderMsl.

  StefanHabel

  committed
  4c11bde

  Copy full SHA for 4c11bde

• Sphinx Python Documentation (AcademySoftwareFoundation#1567) - Added docstrings to PyMaterialXRenderOsl.

  StefanHabel

  committed
  9d73ddc

  Copy full SHA for 9d73ddc

• Sphinx Python Documentation (AcademySoftwareFoundation#1567) - Updated listings of modules in README.md files.

  StefanHabel

  committed
  0e1e502

  Copy full SHA for 0e1e502

• Sphinx Python Documentation (AcademySoftwareFoundation#1567) - Removed aliasing of PyMaterialXFormat.readFromXmlFile() function.

  Show description for 805f13c
  StefanHabel

  committed
  805f13c

  Copy full SHA for 805f13c

Commits on Oct 20, 2023

• Fixed a couple of typos in MaterialXGenShader/Util.h.

  Show description for c0d65ed
  StefanHabel

  committed
  c0d65ed

  Copy full SHA for c0d65ed

• Added PYMATERIALX_IMPORT_MODULE macro to import a PyMaterialX module

  Show description for ab6860b
  StefanHabel

  committed
  ab6860b

  Copy full SHA for ab6860b

• Added PYMATERIALX_DOCSTRING macro to erase the first newline character

  Show description for 26a972f
  StefanHabel

  committed
  26a972f

  Copy full SHA for 26a972f

• Added warnings and statistics to the Sphinx generation.

  Show description for b8eecc0
  StefanHabel

  committed
  b8eecc0

  Copy full SHA for b8eecc0

Commits on Oct 21, 2023

• Added section describing the MaterialX Python API. (AcademySoftwareFoundation#1567)

  Show description for bf427e4
  StefanHabel

  committed
  bf427e4

  Copy full SHA for bf427e4

• Added links to source folders on GitHub to module template. (AcademySoftwareFoundation#1567)

  Show description for fbe2947
  StefanHabel

  committed
  fbe2947

  Copy full SHA for fbe2947

• Extended build checks to warn about undocumented functions and methods. (AcademySoftwareFoundation#1567)

  Show description for f064a22
  StefanHabel

  committed
  f064a22

  Copy full SHA for f064a22

• Tweaked custom style sheet regarding highlighting and indexes. (AcademySoftwareFoundation#1567)

  Show description for d30276b
  StefanHabel

  committed
  d30276b

  Copy full SHA for d30276b

• More docstrings for methods in the Element class. (AcademySoftwareFoundation#1567)

  Show description for 86030d0
  StefanHabel

  committed
  86030d0

  Copy full SHA for 86030d0

• Revised example code in utility functions of PyMaterialXCore. (AcademySoftwareFoundation#1567)

  Show description for 90c78d4
  StefanHabel

  committed
  90c78d4

  Copy full SHA for 90c78d4

Commits on Oct 25, 2023

• Merge branch 'main' into AcademySoftwareFoundation#342-Sphinx-Python-Documentation

  Show description for 37f1ef5
  jstone-lucasfilm

  authored
  37f1ef5

  Copy full SHA for 37f1ef5

Commits on Oct 31, 2023

• Extended docstrings of PyMaterialXCore and PyMaterialXFormat. (AcademySoftwareFoundation#1567)

  Show description for aed7f8f
  StefanHabel

  committed
  aed7f8f

  Copy full SHA for aed7f8f

• Tweaked module template to clarify module source links. (AcademySoftwareFoundation#1567)

  Show description for 052f38e
  StefanHabel

  committed
  052f38e

  Copy full SHA for 052f38e

• Fixed a typo in messages at the end of the Sphinx build. (AcademySoftwareFoundation#1567)

  Show description for 939c996
  StefanHabel

  committed
  939c996

  Copy full SHA for 939c996

• Exposed Element.getChild() in the Python API docs. (AcademySoftwareFoundation#1567)

  Show description for 77b5944
  StefanHabel

  committed
  77b5944

  Copy full SHA for 77b5944

• More fixes in header files in MaterialXCore. (AcademySoftwareFoundation#1567)

  Show description for be2db5e
  StefanHabel

  committed
  be2db5e

  Copy full SHA for be2db5e

• More fixes in header files. (AcademySoftwareFoundation#1567)

  Show description for 71bd3fd
  StefanHabel

  committed
  71bd3fd

  Copy full SHA for 71bd3fd

• Tweaked PYMATERIALX_DOCSTRING macro to also trim the last character. (AcademySoftwareFoundation#1567)

  Show description for f7bea44
  StefanHabel

  committed
  f7bea44

  Copy full SHA for f7bea44

• Tweaked contents of index page. (AcademySoftwareFoundation#1567)

  Show description for e66a3f5
  StefanHabel

  committed
  e66a3f5

  Copy full SHA for e66a3f5

• Minor tweak of Jinja template for module pages. (AcademySoftwareFoundation#1567)

  Show description for 28fd863
  StefanHabel

  committed
  28fd863

  Copy full SHA for 28fd863

• Support for listing properties and attributes of classes separately. (AcademySoftwareFoundation#1567)

  Show description for 74872ea
  StefanHabel

  committed
  74872ea

  Copy full SHA for 74872ea

• Tweaked style sheet. (AcademySoftwareFoundation#1567)

  Show description for 572089b
  StefanHabel

  committed
  572089b

  Copy full SHA for 572089b

• Simplified detection of class names by defining a handler for 'autodoc-process-bases'. (AcademySoftwareFoundation#1567)

  Show description for 513ef90
  StefanHabel

  committed
  513ef90

  Copy full SHA for 513ef90

• Docstrings for PyMaterialXCore. (AcademySoftwareFoundation#1567)

  Show description for c9a2469
  StefanHabel

  committed
  c9a2469

  Copy full SHA for c9a2469

• Docstrings for PyMaterialXFormat. (AcademySoftwareFoundation#1567)

  Show description for 21eecdd
  StefanHabel

  committed
  21eecdd

  Copy full SHA for 21eecdd

• Docstrings for PyMaterialXGenGlsl. (AcademySoftwareFoundation#1567)

  Show description for 40079f1
  StefanHabel

  committed
  40079f1

  Copy full SHA for 40079f1

• Docstrings for PyMaterialXGenMdl. (AcademySoftwareFoundation#1567)

  Show description for dfa106a
  StefanHabel

  committed
  dfa106a

  Copy full SHA for dfa106a

• Docstrings for PyMaterialXGenMsl. (AcademySoftwareFoundation#1567)

  Show description for f62be3a
  StefanHabel

  committed
  f62be3a

  Copy full SHA for f62be3a

• Docstrings for PyMaterialXGenOsl. (AcademySoftwareFoundation#1567)

  Show description for 77ca69c
  StefanHabel

  committed
  77ca69c

  Copy full SHA for 77ca69c

• Docstrings for PyMaterialXGenShader. (AcademySoftwareFoundation#1567)

  Show description for 6253abc
  StefanHabel

  committed
  6253abc

  Copy full SHA for 6253abc

• Docstrings for PyMaterialXRender. (AcademySoftwareFoundation#1567)

  Show description for c1b31c0
  StefanHabel

  committed
  c1b31c0

  Copy full SHA for c1b31c0

• Docstrings for PyMaterialXRenderGlsl. (AcademySoftwareFoundation#1567)

  Show description for 0ca9f23
  StefanHabel

  committed
  0ca9f23

  Copy full SHA for 0ca9f23

• ocstrings for PyMaterialXRenderMsl. (AcademySoftwareFoundation#1567)

  Show description for f73acc4
  StefanHabel

  committed
  f73acc4

  Copy full SHA for f73acc4

• Docstrings for PyMaterialXRenderOsl. (AcademySoftwareFoundation#1567)

  Show description for b589282
  StefanHabel

  committed
  b589282

  Copy full SHA for b589282