114 lines
5.1 KiB
Python
114 lines
5.1 KiB
Python
#!/usr/bin/env python
|
|
'''
|
|
Print markdown documentation for each nodedef in the given document.
|
|
'''
|
|
|
|
import argparse
|
|
import sys
|
|
|
|
import MaterialX as mx
|
|
|
|
HEADERS = ('Name', 'Type', 'Default Value',
|
|
'UI name', 'UI min', 'UI max', 'UI Soft Min', 'UI Soft Max', 'UI step', 'UI group', 'UI Advanced', 'Doc', 'Uniform')
|
|
|
|
ATTR_NAMES = ('uiname', 'uimin', 'uimax', 'uisoftmin', 'uisoftmax', 'uistep', 'uifolder', 'uiadvanced', 'doc', 'uniform' )
|
|
|
|
def main():
|
|
parser = argparse.ArgumentParser(description="Print documentation for each nodedef in the given document.")
|
|
parser.add_argument(dest="inputFilename", help="Filename of the input MaterialX document.")
|
|
parser.add_argument('--docType', dest='documentType', default='md', help='Document type. Default is "md" (Markdown). Specify "html" for HTML output')
|
|
parser.add_argument('--showInherited', default=False, action='store_true', help='Show inherited inputs. Default is False')
|
|
opts = parser.parse_args()
|
|
|
|
doc = mx.createDocument()
|
|
try:
|
|
mx.readFromXmlFile(doc, opts.inputFilename)
|
|
except mx.ExceptionFileMissing as err:
|
|
print(err)
|
|
sys.exit(0)
|
|
|
|
for nd in doc.getNodeDefs():
|
|
# HTML output
|
|
if opts.documentType == "html":
|
|
print('<head><style>')
|
|
print('table, th, td {')
|
|
print(' border-bottom: 1px solid; border-collapse: collapse; padding: 10px;')
|
|
print('}')
|
|
print('</style></head>')
|
|
print('<ul>')
|
|
print('<li> <em>Nodedef</em>: %s' % nd.getName())
|
|
print('<li> <em>Type</em>: %s' % nd.getType())
|
|
if len(nd.getNodeGroup()) > 0:
|
|
print('<li> <em>Node Group</em>: %s' % nd.getNodeGroup())
|
|
if len(nd.getVersionString()) > 0:
|
|
print('<li> <em>Version</em>: %s. Is default: %s' % (nd.getVersionString(), nd.getDefaultVersion()))
|
|
if len(nd.getInheritString()) > 0:
|
|
print('<li> <em>Inherits From</em>: %s' % nd.getInheritString())
|
|
print('<li> <em>Doc</em>: %s\n' % nd.getAttribute('doc'))
|
|
print('</ul>')
|
|
print('<table><tr>')
|
|
for h in HEADERS:
|
|
print('<th>' + h + '</th>')
|
|
print('</tr>')
|
|
inputList = nd.getActiveInputs() if opts.showInherited else nd.getInputs()
|
|
tokenList = nd.getActiveTokens() if opts.showInherited else nd.getTokens()
|
|
outputList = nd.getActiveOutputs() if opts.showInherited else nd.getOutputs()
|
|
totalList = inputList + tokenList + outputList;
|
|
for port in totalList:
|
|
print('<tr>')
|
|
infos = []
|
|
if port in outputList:
|
|
infos.append('<em>'+ port.getName() + '</em>')
|
|
elif port in tokenList:
|
|
infos.append(port.getName())
|
|
else:
|
|
infos.append('<b>'+ port.getName() + '</b>')
|
|
infos.append(port.getType())
|
|
val = port.getValue()
|
|
if port.getType() == "float":
|
|
val = round(val, 6)
|
|
infos.append(str(val))
|
|
for attrname in ATTR_NAMES:
|
|
infos.append(port.getAttribute(attrname))
|
|
for info in infos:
|
|
print('<td>' + info + '</td>')
|
|
print('</tr>')
|
|
print('</table>')
|
|
|
|
# Markdown output
|
|
else:
|
|
print('- *Nodedef*: %s' % nd.getName())
|
|
print('- *Type*: %s' % nd.getType())
|
|
if len(nd.getNodeGroup()) > 0:
|
|
print('- *Node Group*: %s' % nd.getNodeGroup())
|
|
if len(nd.getVersionString()) > 0:
|
|
print('- *Version*: %s. Is default: %s' % (nd.getVersionString(), nd.getDefaultVersion()))
|
|
if len(nd.getInheritString()) > 0:
|
|
print('- *Inherits From*: %s' % nd.getInheritString())
|
|
print('- *Doc*: %s\n' % nd.getAttribute('doc'))
|
|
print('| ' + ' | '.join(HEADERS) + ' |')
|
|
print('|' + ' ---- |' * len(HEADERS) + '')
|
|
inputList = nd.getActiveInputs() if opts.showInherited else nd.getInputs()
|
|
tokenList = nd.getActiveTokens() if opts.showInherited else nd.getTokens()
|
|
outputList = nd.getActiveOutputs() if opts.showInherited else nd.getOutputs()
|
|
totalList = inputList + tokenList + outputList;
|
|
for port in totalList:
|
|
infos = []
|
|
if port in outputList:
|
|
infos.append('*'+ port.getName() + '*')
|
|
elif port in tokenList:
|
|
infos.append(port.getName())
|
|
else:
|
|
infos.append('**'+ port.getName() + '**')
|
|
infos.append(port.getType())
|
|
val = port.getValue()
|
|
if port.getType() == "float":
|
|
val = round(val, 6)
|
|
infos.append(str(val))
|
|
for attrname in ATTR_NAMES:
|
|
infos.append(port.getAttribute(attrname))
|
|
print('| ' + " | ".join(infos) + ' |')
|
|
|
|
if __name__ == '__main__':
|
|
main()
|