Skip to content

Commit 05959ad

Browse files
michdolanmichdolan
committed
Remove frozen docs
Signed-off-by: Michael Dolan <[email protected]>
1 parent c5d6c1a commit 05959ad

File tree

294 files changed

+673
-12153
lines changed

Some content is hidden

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

294 files changed

+673
-12153
lines changed

‎CMakeLists.txt‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -144,8 +144,7 @@ option(OCIO_BUILD_TESTS "Specify whether to build unittests" ON)
144144
option(OCIO_BUILD_GPU_TESTS "Specify whether to build gpu unittests" ON)
145145
option(OCIO_USE_HEADLESS "Specify whether the GPU rendering is headless" OFF)
146146

147-
option(OCIO_BUILD_FROZEN_DOCS "Specify whether to build frozen documentation, necessary when modifying the OCIO public API" OFF)
148-
option(OCIO_BUILD_DOCS "Specify whether to build documentation" ${OCIO_BUILD_FROZEN_DOCS})
147+
option(OCIO_BUILD_DOCS "Specify whether to build documentation" OFF)
149148

150149
option(OCIO_BUILD_PYTHON "Specify whether to build python bindings" ON)
151150
set (OCIO_PYTHON_VERSION "" CACHE STRING

‎docs/api/apphelpers.rst‎

Lines changed: 40 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,22 @@ ColorSpaceMenuHelpers
1212

1313
.. group-tab:: Python
1414

15-
.. include:: python/${PYDIR}/pyopencolorio_colorspacehelpers.rst
15+
.. autofunction:: PyOpenColorIO.ColorSpaceHelpers.AddColorSpace
16+
17+
.. autoclass:: PyOpenColorIO.ColorSpaceMenuParameters
18+
:members:
19+
:undoc-members:
20+
:special-members: __init__, __str__
21+
:exclude-members: AddedColorSpaceIterator
22+
23+
.. autoclass:: PyOpenColorIO.ColorSpaceMenuHelper
24+
:members:
25+
:undoc-members:
26+
:special-members: __init__, __str__
27+
:exclude-members: ColorSpaceLevelIterator
28+
29+
.. autoclass:: PyOpenColorIO.ColorSpaceMenuHelper.ColorSpaceLevelIterator
30+
:special-members: __getitem__, __iter__, __len__, __next__
1631

1732
.. group-tab:: C++
1833

@@ -38,7 +53,10 @@ DisplayViewHelpers
3853

3954
.. group-tab:: Python
4055

41-
.. include:: python/${PYDIR}/pyopencolorio_displayviewhelpers.rst
56+
.. autofunction:: PyOpenColorIO.DisplayViewHelpers.GetProcessor
57+
.. autofunction:: PyOpenColorIO.DisplayViewHelpers.GetIdentityProcessor
58+
.. autofunction:: PyOpenColorIO.DisplayViewHelpers.AddDisplayView
59+
.. autofunction:: PyOpenColorIO.DisplayViewHelpers.RemoveDisplayView
4260

4361
.. group-tab:: C++
4462

@@ -53,7 +71,10 @@ LegacyViewingPipeline
5371

5472
.. group-tab:: Python
5573

56-
.. include:: python/${PYDIR}/pyopencolorio_legacyviewingpipeline.rst
74+
.. autoclass:: PyOpenColorIO.LegacyViewingPipeline
75+
:members:
76+
:undoc-members:
77+
:special-members: __init__, __str__
5778

5879
.. group-tab:: C++
5980

@@ -73,7 +94,22 @@ MixingHelpers
7394

7495
.. group-tab:: Python
7596

76-
.. include:: python/${PYDIR}/pyopencolorio_mixinghelpers.rst
97+
.. autoclass:: PyOpenColorIO.MixingSlider
98+
:members:
99+
:undoc-members:
100+
:special-members: __init__, __str__
101+
102+
.. autoclass:: PyOpenColorIO.MixingColorSpaceManager
103+
:members:
104+
:undoc-members:
105+
:special-members: __init__, __str__
106+
:exclude-members: MixingSpaceIterator, MixingEncodingIterator
107+
108+
.. autoclass:: PyOpenColorIO.MixingColorSpaceManager.MixingSpaceIterator
109+
:special-members: __getitem__, __iter__, __len__, __next__
110+
111+
.. autoclass:: PyOpenColorIO.MixingColorSpaceManager.MixingEncodingIterator
112+
:special-members: __getitem__, __iter__, __len__, __next__
77113

78114
.. group-tab:: C++
79115

‎docs/api/baker.rst‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,14 @@ Baker
99

1010
.. group-tab:: Python
1111

12-
.. include:: python/${PYDIR}/pyopencolorio_baker.rst
12+
.. autoclass:: PyOpenColorIO.Baker
13+
:members:
14+
:undoc-members:
15+
:special-members: __init__
16+
:exclude-members: FormatIterator
17+
18+
.. autoclass:: PyOpenColorIO.Baker.FormatIterator
19+
:special-members: __getitem__, __iter__, __len__, __next__
1320

1421
.. group-tab:: C++
1522

‎docs/api/colorspace.rst‎

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,17 @@ ColorSpace
99

1010
.. group-tab:: Python
1111

12-
.. include:: python/${PYDIR}/pyopencolorio_colorspace.rst
12+
.. autoclass:: PyOpenColorIO.ColorSpace
13+
:members:
14+
:undoc-members:
15+
:special-members: __init__, __str__
16+
:exclude-members: ColorSpaceCategoryIterator, ColorSpaceAliasIterator
17+
18+
.. autoclass:: PyOpenColorIO.ColorSpace.ColorSpaceCategoryIterator
19+
:special-members: __getitem__, __iter__, __len__, __next__
20+
21+
.. autoclass:: PyOpenColorIO.ColorSpace.ColorSpaceAliasIterator
22+
:special-members: __getitem__, __iter__, __len__, __next__
1323

1424
.. group-tab:: C++
1525

@@ -29,7 +39,17 @@ ColorSpaceSet
2939

3040
.. group-tab:: Python
3141

32-
.. include:: python/${PYDIR}/pyopencolorio_colorspaceset.rst
42+
.. autoclass:: PyOpenColorIO.ColorSpaceSet
43+
:members:
44+
:undoc-members:
45+
:special-members: __init__, __eq__, __ne__, __sub__, __or__, __and__
46+
:exclude-members: ColorSpaceNameIterator, ColorSpaceIterator
47+
48+
.. autoclass:: PyOpenColorIO.ColorSpaceSet.ColorSpaceNameIterator
49+
:special-members: __getitem__, __iter__, __len__, __next__
50+
51+
.. autoclass:: PyOpenColorIO.ColorSpaceSet.ColorSpaceIterator
52+
:special-members: __getitem__, __iter__, __len__, __next__
3353

3454
.. group-tab:: C++
3555

‎docs/api/config.rst‎

Lines changed: 84 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,90 @@ Config
99

1010
.. group-tab:: Python
1111

12-
.. include:: python/${PYDIR}/pyopencolorio_config.rst
12+
.. autoclass:: PyOpenColorIO.Config
13+
:members:
14+
:undoc-members:
15+
:special-members: __init__, __str__
16+
:exclude-members: EnvironmentVarNameIterator,
17+
SearchPathIterator,
18+
ColorSpaceNameIterator,
19+
ColorSpaceIterator,
20+
ActiveColorSpaceNameIterator,
21+
ActiveColorSpaceIterator,
22+
RoleNameIterator,
23+
RoleColorSpaceIterator,
24+
DisplayIterator,
25+
SharedViewIterator,
26+
ViewIterator,
27+
ViewForColorSpaceIterator,
28+
LookNameIterator,
29+
LookIterator,
30+
ViewTransformNameIterator,
31+
ViewTransformIterator,
32+
NamedTransformNameIterator,
33+
NamedTransformIterator,
34+
ActiveNamedTransformNameIterator,
35+
ActiveNamedTransformIterator
36+
37+
.. autoclass:: PyOpenColorIO.Config.EnvironmentVarNameIterator
38+
:special-members: __getitem__, __iter__, __len__, __next__
39+
40+
.. autoclass:: PyOpenColorIO.Config.SearchPathIterator
41+
:special-members: __getitem__, __iter__, __len__, __next__
42+
43+
.. autoclass:: PyOpenColorIO.Config.ColorSpaceNameIterator
44+
:special-members: __getitem__, __iter__, __len__, __next__
45+
46+
.. autoclass:: PyOpenColorIO.Config.ColorSpaceIterator
47+
:special-members: __getitem__, __iter__, __len__, __next__
48+
49+
.. autoclass:: PyOpenColorIO.Config.ActiveColorSpaceNameIterator
50+
:special-members: __getitem__, __iter__, __len__, __next__
51+
52+
.. autoclass:: PyOpenColorIO.Config.ActiveColorSpaceIterator
53+
:special-members: __getitem__, __iter__, __len__, __next__
54+
55+
.. autoclass:: PyOpenColorIO.Config.RoleNameIterator
56+
:special-members: __getitem__, __iter__, __len__, __next__
57+
58+
.. autoclass:: PyOpenColorIO.Config.RoleColorSpaceIterator
59+
:special-members: __getitem__, __iter__, __len__, __next__
60+
61+
.. autoclass:: PyOpenColorIO.Config.DisplayIterator
62+
:special-members: __getitem__, __iter__, __len__, __next__
63+
64+
.. autoclass:: PyOpenColorIO.Config.SharedViewIterator
65+
:special-members: __getitem__, __iter__, __len__, __next__
66+
67+
.. autoclass:: PyOpenColorIO.Config.ViewIterator
68+
:special-members: __getitem__, __iter__, __len__, __next__
69+
70+
.. autoclass:: PyOpenColorIO.Config.ViewForColorSpaceIterator
71+
:special-members: __getitem__, __iter__, __len__, __next__
72+
73+
.. autoclass:: PyOpenColorIO.Config.LookNameIterator
74+
:special-members: __getitem__, __iter__, __len__, __next__
75+
76+
.. autoclass:: PyOpenColorIO.Config.LookIterator
77+
:special-members: __getitem__, __iter__, __len__, __next__
78+
79+
.. autoclass:: PyOpenColorIO.Config.ViewTransformNameIterator
80+
:special-members: __getitem__, __iter__, __len__, __next__
81+
82+
.. autoclass:: PyOpenColorIO.Config.ViewTransformIterator
83+
:special-members: __getitem__, __iter__, __len__, __next__
84+
85+
.. autoclass:: PyOpenColorIO.Config.NamedTransformNameIterator
86+
:special-members: __getitem__, __iter__, __len__, __next__
87+
88+
.. autoclass:: PyOpenColorIO.Config.NamedTransformIterator
89+
:special-members: __getitem__, __iter__, __len__, __next__
90+
91+
.. autoclass:: PyOpenColorIO.Config.ActiveNamedTransformNameIterator
92+
:special-members: __getitem__, __iter__, __len__, __next__
93+
94+
.. autoclass:: PyOpenColorIO.Config.ActiveNamedTransformIterator
95+
:special-members: __getitem__, __iter__, __len__, __next__
1396

1497
.. group-tab:: C++
1598

‎docs/api/context.rst‎

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,22 @@ Context
99

1010
.. group-tab:: Python
1111

12-
.. include:: python/${PYDIR}/pyopencolorio_context.rst
12+
.. autoclass:: PyOpenColorIO.Context
13+
:members:
14+
:undoc-members:
15+
:special-members: __init__, __str__
16+
:exclude-members: StringVarNameIterator,
17+
StringVarIterator,
18+
SearchPathIterator
19+
20+
.. autoclass:: PyOpenColorIO.Context.StringVarNameIterator
21+
:special-members: __getitem__, __iter__, __len__, __next__
22+
23+
.. autoclass:: PyOpenColorIO.Context.StringVarIterator
24+
:special-members: __getitem__, __iter__, __len__, __next__
25+
26+
.. autoclass:: PyOpenColorIO.Context.SearchPathIterator
27+
:special-members: __getitem__, __iter__, __len__, __next__
1328

1429
.. group-tab:: C++
1530

‎docs/api/dynamicproperty.rst‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,10 @@ DynamicProperty
99

1010
.. group-tab:: Python
1111

12-
.. include:: python/${PYDIR}/pyopencolorio_dynamicproperty.rst
12+
.. autoclass:: PyOpenColorIO.DynamicProperty
13+
:members:
14+
:undoc-members:
15+
:special-members: __init__
1316

1417
.. group-tab:: C++
1518

0 commit comments

Comments
 (0)