Skip to content

Commit ef139b1

Browse files
kwokcbkwokcb
committed
More doc fixes
Update index.html Update static.yml Update static.yml docs update. Bump build to 1.39.5 (dev) and ocio 2.5.0 (#4)
1 parent 2a8f956 commit ef139b1

File tree

144 files changed

+5017
-24896
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

144 files changed

+5017
-24896
lines changed

‎.github/workflows/static.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@ jobs:
3636
- name: Upload artifact
3737
uses: actions/upload-pages-artifact@v3
3838
with:
39-
# Upload entire repository
40-
path: '.'
39+
path: .
4140
- name: Deploy to GitHub Pages
4241
id: deployment
4342
uses: actions/deploy-pages@v4
43+

‎README.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -376,22 +376,22 @@ <h3 id="installation">Installation</h3>
376376
</div></code></pre>
377377
<p>The distribution will be available on PyPi in the near future as <code>materialxocio</code>.</p>
378378
<h3 id="dependencies">Dependencies</h3>
379-
<p>The utilities require the following dependencies:</p>
379+
<p>The utilities have the following minimal dependencies:</p>
380380
<ul>
381381
<li>OpenColorIO 2.2 and above</li>
382382
<li>MaterialX 1.38.9 and above</li>
383383
</ul>
384-
<p>The latest version tested with is MaterialX 1.39.2 and OpenColorIO 2.4.1</p>
384+
<p>The latest version tested with is MaterialX 1.39.5 (development) and OpenColorIO 2.5.0 (release)</p>
385385
<h3 id="command-line-utilities">Command Line Utilities</h3>
386386
<p>The repository contains the following command line utilities:</p>
387387
<ul>
388-
<li>generateOCIODefinitions: Generates MaterialX node definitions from the default ACES Cg config for<br>
388+
<li>generateOCIODefinitions: Generates MaterialX node definitions from the default ACES Cg config for
389389
color transforms without LUTs. Each transform is from the source colorspace to lin_rec709.</li>
390390
<li>If source code implementations are generated, each definition consists of:
391391
<ul>
392392
<li>A node definition MaterialX file</li>
393393
<li>A node implementation MaterialX file</li>
394-
<li>Source code in the GLSL shading language. Note that options to use other OCIO<br>
394+
<li>Source code in the GLSL shading language. Note that options to use other OCIO
395395
provided languages can be added.</li>
396396
</ul>
397397
</li>

‎README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,12 @@ The distribution will be available on PyPi in the near future as `materialxocio`
2020

2121
### Dependencies
2222

23-
The utilities require the following dependencies:
23+
The utilities have the following minimal dependencies:
2424

2525
- OpenColorIO 2.2 and above
2626
- MaterialX 1.38.9 and above
2727

28-
The latest version tested with is MaterialX 1.39.2 and OpenColorIO 2.4.1
28+
The latest version tested with is MaterialX 1.39.5 (development) and OpenColorIO 2.5.0 (release)
2929

3030
### Command Line Utilities
3131

‎docs/Doxyfile‎

Lines changed: 775 additions & 459 deletions
Large diffs are not rendered by default.

‎docs/data/acescg_to_lin_rec709_color3.mtlx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
</convert>
1111
<transform name="matrixTransform" type="vector3">
1212
<input name="in" type="vector3" nodename="asVec" />
13-
<input name="mat" type="matrix33" value="1.7050509926579815, -0.6217921206570056, -0.0832588720009797, -0.1302564175070435, 1.1408047365754048, -0.010548319068357653, -0.024003356804618042, -0.1289689760649709, 1.1529723328695858" />
13+
<input name="mat" type="matrix33" value="1.7050509926579815, -0.6217921206570057, -0.08325887200097967, -0.1302564175070435, 1.140804736575405, -0.010548319068357662, -0.024003356804618046, -0.12896897606497093, 1.1529723328695858" />
1414
</transform>
1515
<convert name="asColor" type="color3">
1616
<input name="in" type="vector3" nodename="matrixTransform" />

‎docs/data/mx_acescg_to_lin_rec709_color4.glsl‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ vec4 mx_acescg_to_lin_rec709_color4(vec4 inPixel)
1010
{
1111
vec4 res = vec4(outColor.rgb.r, outColor.rgb.g, outColor.rgb.b, outColor.a);
1212
vec4 tmp = res;
13-
res = mat4(1.7050509926579815, -0.1302564175070435, -0.024003356804618042, 0., -0.62179212065700562, 1.1408047365754048, -0.1289689760649709, 0., -0.0832588720009797, -0.010548319068357653, 1.1529723328695858, 0., 0., 0., 0., 1.) * tmp;
13+
res = mat4(1.7050509926579815, -0.1302564175070435, -0.024003356804618046, 0., -0.62179212065700573, 1.140804736575405, -0.12896897606497093, 0., -0.083258872000979672, -0.010548319068357662, 1.1529723328695858, 0., 0., 0., 0., 1.) * tmp;
1414
outColor.rgb = vec3(res.x, res.y, res.z);
1515
outColor.a = res.w;
1616
}

‎docs/data/mx_acescg_to_lin_rec709_color4.osl‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,7 @@
88

99
vector4 __operator__mul__(matrix m, vector4 v)
1010
{
11-
return vector4(v.x * m[0][0] + v.y * m[0][1] + v.z * m[0][2] + v.w * m[0][3],
12-
v.x * m[1][0] + v.y * m[1][1] + v.z * m[1][2] + v.w * m[1][3],
13-
v.x * m[2][0] + v.y * m[2][1] + v.z * m[2][2] + v.w * m[2][3],
14-
v.x * m[3][0] + v.y * m[3][1] + v.z * m[3][2] + v.w * m[3][3]);
11+
return transform(m, v);
1512
}
1613

1714
vector4 __operator__mul__(color4 c, vector4 v)
@@ -54,6 +51,7 @@ vector4 max(vector4 v, color4 c)
5451
shader OSL_mx_acescg_to_lin_rec709_color4(color4 inColor = {color(0), 1}, output color4 outColor = {color(0), 1})
5552
{
5653

54+
5755
// Declaration of the OCIO shader function
5856

5957
color4 mx_acescg_to_lin_rec709_color4(color4 inPixel)
@@ -65,7 +63,7 @@ color4 mx_acescg_to_lin_rec709_color4(color4 inPixel)
6563
{
6664
vector4 res = vector4(outColor.rgb.r, outColor.rgb.g, outColor.rgb.b, outColor.a);
6765
vector4 tmp = res;
68-
res = matrix(1.7050509926579815, -0.62179212065700562, -0.0832588720009797, 0., -0.1302564175070435, 1.1408047365754048, -0.010548319068357653, 0., -0.024003356804618042, -0.1289689760649709, 1.1529723328695858, 0., 0., 0., 0., 1.) * tmp;
66+
res = matrix(1.7050509926579815, -0.1302564175070435, -0.024003356804618046, 0., -0.62179212065700573, 1.140804736575405, -0.12896897606497093, 0., -0.083258872000979672, -0.010548319068357662, 1.1529723328695858, 0., 0., 0., 0., 1.) * tmp;
6967
outColor.rgb = vector(res.x, res.y, res.z);
7068
outColor.a = res.w;
7169
}

‎docs/doxygen_log.txt‎

Lines changed: 17 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,24 @@
1-
warning: Tag 'OUTPUT_TEXT_DIRECTION' at line 102 of file 'Doxyfile' has become obsolete.
2-
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
3-
warning: Tag 'HTML_TIMESTAMP' at line 1335 of file 'Doxyfile' has become obsolete.
4-
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
5-
warning: Tag 'FORMULA_TRANSPARENT' at line 1640 of file 'Doxyfile' has become obsolete.
6-
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
7-
warning: Tag 'LATEX_SOURCE_CODE' at line 1953 of file 'Doxyfile' has become obsolete.
8-
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
9-
warning: Tag 'LATEX_TIMESTAMP' at line 1969 of file 'Doxyfile' has become obsolete.
10-
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
11-
warning: Tag 'RTF_SOURCE_CODE' at line 2043 of file 'Doxyfile' has become obsolete.
12-
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
13-
warning: Tag 'DOCBOOK_PROGRAMLISTING' at line 2148 of file 'Doxyfile' has become obsolete.
14-
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
15-
warning: Tag 'CLASS_DIAGRAMS' at line 2335 of file 'Doxyfile' has become obsolete.
16-
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
17-
warning: Tag 'DOT_FONTNAME' at line 2377 of file 'Doxyfile' has become obsolete.
18-
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
19-
warning: Tag 'DOT_FONTSIZE' at line 2384 of file 'Doxyfile' has become obsolete.
20-
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
21-
warning: Tag 'DOT_TRANSPARENT' at line 2630 of file 'Doxyfile' has become obsolete.
22-
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
23-
warning: tag INCLUDE_PATH: include path './src' does not exist
24-
warning: source './src' is not a readable file or directory... skipping.
25-
warning: Specified markdown mainpage 'README.md' does not exist
26-
D:/work/materialx/MaterialXocio/src/materialxocio/core.py:57: warning: Member printConfigs(self, configs) (function) of class materialxocio.core.OCIOMaterialaxGenerator is not documented.
27-
D:/work/materialx/MaterialXocio/src/materialxocio/core.py:82: warning: Member setShaderDescriptionParameters(self, shaderDesc, sourceSpace, targetSpace, typeName) (function) of class materialxocio.core.OCIOMaterialaxGenerator is not documented.
28-
D:/work/materialx/MaterialXocio/src/materialxocio/core.py:186: warning: Member MSL(self, config, sourceColorSpace, targetColorSpace) (function) of class materialxocio.core.OCIOMaterialaxGenerator is not documented.
29-
D:/work/materialx/MaterialXocio/src/materialxocio/core.py:193: warning: Member OSL(self, config, sourceColorSpace, targetColorSpace) (function) of class materialxocio.core.OCIOMaterialaxGenerator is not documented.
30-
D:/work/materialx/MaterialXocio/src/materialxocio/genOCIODefinitions.py:29: warning: Member main() (function) of namespace materialxocio.genOCIODefinitions is not documented.
31-
Doxygen version used: 1.12.0 (c73f5d30f9e8b1df5ba15a1d064ff2067cbb8267)
1+
Doxygen version used: 1.15.0
322
Searching for include files...
3+
Searching for files in directory /Users/bernardkwok/work/materialxocio/src
334
Searching for example files...
345
Searching for images...
356
Searching for dot files...
367
Searching for msc files...
378
Searching for dia files...
9+
Searching for plantuml files...
3810
Searching for files to exclude
3911
Searching INPUT for files to process...
40-
Searching for files in directory D:/work/materialx/MaterialXocio/src/materialxocio
41-
Searching for files in directory D:/work/materialx/MaterialXocio/
12+
Searching for files in directory /Users/bernardkwok/work/materialxocio/src/materialxocio
4213
Reading and parsing tag files
4314
Parsing files
44-
Reading D:/work/materialx/MaterialXocio/src/materialxocio/__init__.py...
45-
Parsing file D:/work/materialx/MaterialXocio/src/materialxocio/__init__.py...
46-
Reading D:/work/materialx/MaterialXocio/src/materialxocio/core.py...
47-
Parsing file D:/work/materialx/MaterialXocio/src/materialxocio/core.py...
48-
Reading D:/work/materialx/MaterialXocio/src/materialxocio/genOCIODefinitions.py...
49-
Parsing file D:/work/materialx/MaterialXocio/src/materialxocio/genOCIODefinitions.py...
50-
Reading D:/work/materialx/MaterialXocio/README.md...
15+
Reading /Users/bernardkwok/work/materialxocio/src/materialxocio/__init__.py...
16+
Parsing file /Users/bernardkwok/work/materialxocio/src/materialxocio/__init__.py...
17+
Reading /Users/bernardkwok/work/materialxocio/src/materialxocio/core.py...
18+
Parsing file /Users/bernardkwok/work/materialxocio/src/materialxocio/core.py...
19+
Reading /Users/bernardkwok/work/materialxocio/src/materialxocio/genOCIODefinitions.py...
20+
Parsing file /Users/bernardkwok/work/materialxocio/src/materialxocio/genOCIODefinitions.py...
21+
Reading /Users/bernardkwok/work/materialxocio/README.md...
5122
Building macro definition list...
5223
Building group list...
5324
Building directory list...
@@ -72,6 +43,7 @@ Searching for documented defines...
7243
Computing class inheritance relations...
7344
Computing class usage relations...
7445
Flushing cached template relations that have become invalid...
46+
Warn for undocumented namespaces...
7547
Computing class relations...
7648
Add enum values to enums...
7749
Searching for member function documentation...
@@ -118,9 +90,9 @@ Generating class documentation...
11890
Generating concept documentation...
11991
Generating module documentation...
12092
Generating namespace documentation...
121-
Generating docs for namespace materialxocio::core
122-
Generating docs for compound materialxocio::core::OCIOMaterialaxGenerator...
123-
Generating docs for namespace materialxocio::genOCIODefinitions
93+
Generating docs for namespace materialxocio.core
94+
Generating docs for compound materialxocio.core.OCIOMaterialaxGenerator...
95+
Generating docs for namespace materialxocio.genOCIODefinitions
12496
Generating graph info page...
12597
Generating directory documentation...
12698
Generating index page...
@@ -142,6 +114,6 @@ Generating example index...
142114
finalizing index lists...
143115
writing tag file...
144116
Running plantuml with JAVA...
145-
type lookup cache used 51/65536 hits=2 misses=51
146-
symbol lookup cache used 52/65536 hits=383 misses=52
117+
type lookup cache used 47/65536 hits=1 misses=47
118+
symbol lookup cache used 55/65536 hits=656 misses=55
147119
finished...

‎docs/html/____init_____8py_source.html‎

Lines changed: 10 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
55
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
6-
<meta name="generator" content="Doxygen 1.12.0"/>
6+
<meta name="generator" content="Doxygen 1.15.0"/>
77
<meta name="viewport" content="width=device-width, initial-scale=1"/>
88
<title>MaterialXOCIO: __init__.py Source File</title>
99
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -13,7 +13,6 @@
1313
<link href="navtree.css" rel="stylesheet" type="text/css"/>
1414
<script type="text/javascript" src="navtreedata.js"></script>
1515
<script type="text/javascript" src="navtree.js"></script>
16-
<script type="text/javascript" src="resize.js"></script>
1716
<script type="text/javascript" src="cookie.js"></script>
1817
<link href="search/search.css" rel="stylesheet" type="text/css"/>
1918
<script type="text/javascript" src="search/searchdata.js"></script>
@@ -28,7 +27,7 @@
2827
<tbody>
2928
<tr id="projectrow">
3029
<td id="projectalign">
31-
<div id="projectname">MaterialXOCIO<span id="projectnumber">&#160;0.1.39.0.1</span>
30+
<div id="projectname">MaterialXOCIO<span id="projectnumber">&#160;0.1.39.5</span>
3231
</div>
3332
<div id="projectbrief">Utilities for using OCIO to generate MaterialX definitions and graphs</div>
3433
</td>
@@ -37,26 +36,20 @@
3736
</table>
3837
</div>
3938
<!-- end header part -->
40-
<!-- Generated by Doxygen 1.12.0 -->
39+
<!-- Generated by Doxygen 1.15.0 -->
4140
<script type="text/javascript">
42-
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
4341
var searchBox = new SearchBox("searchBox", "search/",'.html');
44-
/* @license-end */
4542
</script>
4643
<script type="text/javascript">
47-
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
48-
$(function() { codefold.init(0); });
49-
/* @license-end */
44+
$(function() { codefold.init(); });
5045
</script>
5146
<script type="text/javascript" src="menudata.js"></script>
5247
<script type="text/javascript" src="menu.js"></script>
5348
<script type="text/javascript">
54-
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
5549
$(function() {
5650
initMenu('',true,false,'search.php','Search',true);
5751
$(function() { init_search(); });
5852
});
59-
/* @license-end */
6053
</script>
6154
<div id="main-nav"></div>
6255
</div><!-- top -->
@@ -71,10 +64,9 @@
7164
</div>
7265
</div>
7366
<script type="text/javascript">
74-
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
75-
$(function(){initNavTree('____init_____8py_source.html',''); initResizable(true); });
76-
/* @license-end */
67+
$(function(){initNavTree('____init_____8py_source.html','',''); });
7768
</script>
69+
<div id="container">
7870
<div id="doc-content">
7971
<!-- window showing the filter options -->
8072
<div id="MSearchSelectWindow"
@@ -102,15 +94,16 @@
10294
</div><!--header-->
10395
<div class="contents">
10496
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment"># Version</span></div>
105-
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span>__version__ = <span class="stringliteral">&#39;0.1.39.2&#39;</span></div>
97+
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span>__version__ = <span class="stringliteral">&#39;0.1.39.5&#39;</span></div>
10698
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div>
10799
</div><!-- fragment --></div><!-- contents -->
108100
</div><!-- doc-content -->
101+
</div><!-- container -->
109102
<!-- start footer part -->
110103
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
111104
<ul>
112-
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_fac5a7ed8ffd2d94e13f059ed632e0b1.html">materialxocio</a></li><li class="navelem"><b>__init__.py</b></li>
113-
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0 </li>
105+
<li class="navelem"><b>src</b></li><li class="navelem"><b>materialxocio</b></li><li class="navelem"><b>__init__.py</b></li>
106+
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.15.0 </li>
114107
</ul>
115108
</div>
116109
</body>

0 commit comments

Comments
 (0)