Skip to content

Commit fcdbf56

Browse files
michdolanmichdolan
authored
Refactor RTD Python API doc generation (#2171)
* Remove frozen docs Signed-off-by: Michael Dolan <[email protected]> * Make opencolorio RTD requirement Signed-off-by: Michael Dolan <[email protected]> * Only install from PyPi on RTD_BUILD Signed-off-by: Michael Dolan <[email protected]> * Trigger PR RTD build Signed-off-by: Michael Dolan <[email protected]> * Restructure pip command Signed-off-by: Michael Dolan <[email protected]> * Fallback to latest PyPi version Signed-off-by: Michael Dolan <[email protected]> * Increase sphinx verbosity for debugging Signed-off-by: Michael Dolan <[email protected]> * Update sphinx verbosity Signed-off-by: Michael Dolan <[email protected]> * Try another verbosity adjustment Signed-off-by: Michael Dolan <[email protected]> * Fix sphinx build command Signed-off-by: Michael Dolan <[email protected]> * Adjusting relative path Signed-off-by: Michael Dolan <[email protected]> * Trying alt build structure Signed-off-by: Michael Dolan <[email protected]> * Another alt build structure Signed-off-by: Michael Dolan <[email protected]> * Try pre-install of OCIO Signed-off-by: Michael Dolan <[email protected]> * Testing platform build Signed-off-by: Michael Dolan <[email protected]> * Revert conf.py __doc__ test Signed-off-by: Michael Dolan <[email protected]> * Update CI to use windows-2022, and linux builds to use apt Signed-off-by: Michael Dolan <[email protected]> * Handle dnf/yum/apt for different workflows Signed-off-by: Michael Dolan <[email protected]> * Fix wheel builds on Linux Signed-off-by: Michael Dolan <[email protected]> * Skip epel install Signed-off-by: Michael Dolan <[email protected]> * Add manual doxygen install option Signed-off-by: Michael Dolan <[email protected]> * Make dnf scripts executable Signed-off-by: Michael Dolan <[email protected]> * special doxygen case for centos Signed-off-by: Michael Dolan <[email protected]> * Trying doxygen 1.9.0 on centos-7 Signed-off-by: Michael Dolan <[email protected]> * Try latest yum install of doxygen Signed-off-by: Michael Dolan <[email protected]> * Turn off docs on CentOS-7 builds Signed-off-by: Michael Dolan <[email protected]> * Add Windows CI with docs Signed-off-by: Michael Dolan <[email protected]> * Use apt for linux wheel builds Signed-off-by: Michael Dolan <[email protected]> * Testing linux distro on wheel builds Signed-off-by: Michael Dolan <[email protected]> * Update yum repos on CentOS-7 Signed-off-by: Michael Dolan <[email protected]> * remove sudo Signed-off-by: Michael Dolan <[email protected]> * Adjust CentOS-7 vault repo URLs Signed-off-by: Michael Dolan <[email protected]> * Add altarch doxygen handling Signed-off-by: Michael Dolan <[email protected]> * Inspect Windows docs env Signed-off-by: Michael Dolan <[email protected]> * Remove status checks Signed-off-by: Michael Dolan <[email protected]> * Re-enable linux-old docs builds Signed-off-by: Michael Dolan <[email protected]> --------- Signed-off-by: Michael Dolan <[email protected]>
1 parent c5d6c1a commit fcdbf56

File tree

307 files changed

+772
-12201
lines changed

Some content is hidden

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

307 files changed

+772
-12201
lines changed

‎.github/workflows/analysis_workflow.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,9 @@ jobs:
4747
- name: Install sonar-scanner and build-wrapper
4848
uses: sonarsource/sonarcloud-github-c-cpp@v2
4949
- name: Install docs env
50-
run: share/ci/scripts/linux/yum/install_docs_env.sh
50+
run: share/ci/scripts/linux/dnf/install_docs_env.sh
5151
- name: Install tests env
52-
run: share/ci/scripts/linux/yum/install_tests_env.sh
52+
run: share/ci/scripts/linux/dnf/install_tests_env.sh
5353
- name: Create build directories
5454
run: |
5555
mkdir _install

‎.github/workflows/ci_workflow.yml‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -154,10 +154,10 @@ jobs:
154154
- name: Checkout
155155
uses: actions/checkout@v4
156156
- name: Install docs env
157-
run: share/ci/scripts/linux/yum/install_docs_env.sh
157+
run: share/ci/scripts/linux/dnf/install_docs_env.sh
158158
if: matrix.build-docs == 'ON'
159159
- name: Install tests env
160-
run: share/ci/scripts/linux/yum/install_tests_env.sh
160+
run: share/ci/scripts/linux/dnf/install_tests_env.sh
161161
- name: Create build directories
162162
run: |
163163
mkdir _install
@@ -366,10 +366,10 @@ jobs:
366366
- name: Checkout
367367
uses: actions/checkout@v3
368368
- name: Install docs env
369-
run: share/ci/scripts/linux/yum/install_docs_env.sh
369+
run: share/ci/scripts/linux/dnf/install_docs_env.sh
370370
if: matrix.build-docs == 'ON'
371371
- name: Install tests env
372-
run: share/ci/scripts/linux/yum/install_tests_env.sh
372+
run: share/ci/scripts/linux/dnf/install_tests_env.sh
373373
- name: Create build directories
374374
run: |
375375
mkdir _install
@@ -462,7 +462,7 @@ jobs:
462462
runs-on: macos-13
463463
strategy:
464464
matrix:
465-
build: [1, 2, 3, 4]
465+
build: [1, 2, 3, 4, 5]
466466
include:
467467
- build: 5
468468
arch-type: "x86_64"
@@ -736,7 +736,7 @@ jobs:
736736
# Debug build testing with Python bindings and docs enabled.
737737

738738
windows:
739-
name: 'Windows 2019
739+
name: 'Windows 2022
740740
<MSVC
741741
config=${{ matrix.build-type }},
742742
shared=${{ matrix.build-shared }},
@@ -749,7 +749,7 @@ jobs:
749749
if: |
750750
github.event_name == 'push' ||
751751
github.event.pull_request.head.repo.full_name != github.repository
752-
runs-on: windows-2019
752+
runs-on: windows-2022
753753
strategy:
754754
matrix:
755755
build: [1, 2, 3, 4]
@@ -766,7 +766,7 @@ jobs:
766766
- build: 3
767767
build-type: Release
768768
build-shared: 'OFF'
769-
build-docs: 'OFF'
769+
build-docs: 'ON'
770770
build-openfx: 'OFF'
771771
use-simd: 'ON'
772772
use-oiio: 'OFF'

‎.github/workflows/dependencies_latest.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -92,10 +92,10 @@ jobs:
9292
- name: Checkout
9393
uses: actions/checkout@v3
9494
- name: Install docs env
95-
run: share/ci/scripts/linux/yum/install_docs_env.sh
95+
run: share/ci/scripts/linux/dnf/install_docs_env.sh
9696
if: matrix.build-docs == 'ON'
9797
- name: Install tests env
98-
run: share/ci/scripts/linux/yum/install_tests_env.sh
98+
run: share/ci/scripts/linux/dnf/install_tests_env.sh
9999
- name: Setup ext environment
100100
run: |
101101
EXT_PATH=/usr/local

‎.github/workflows/platform_latest.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ jobs:
8888
- name: Checkout
8989
uses: actions/checkout@v4
9090
- name: Install tests env
91-
run: share/ci/scripts/linux/yum/install_tests_env.sh
91+
run: share/ci/scripts/linux/dnf/install_tests_env.sh
9292
- name: Create build directories
9393
run: |
9494
mkdir _install

‎.readthedocs.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ version: 2
99
build:
1010
os: ubuntu-20.04
1111
tools:
12-
python: "3.9"
12+
python: "3.11"
1313

1414
sphinx:
1515
configuration: docs/conf.py

‎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/CMakeLists.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ if(${Python_VERSION_MAJOR} GREATER_EQUAL 3)
4545
# Breathe
4646
# https://pypi.org/project/breathe/
4747
find_python_package(breathe REQUIRED)
48-
48+
4949
###########################################################################
5050
### Setup PYTHONPATH ###
5151

‎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

0 commit comments

Comments
 (0)