Update documentation.

Signed-off-by: Thomas Mansencal <[email protected]>

Author: KelSolaar

README.rst

@@ -117,40 +117,40 @@ The **OpenColorIO Configuration for ACES** package requires various
 dependencies in order to run and be able to generate the *OCIO* configurations:
 
 Primary Dependencies
-********************
+~~~~~~~~~~~~~~~~~~~~
 
--   `python >= 3.10, < 3.14 <https://www.python.org/download/releases>`__
--   `opencolorio <https://pypi.org/project/opencolorio>`__
--   `requests <https://pypi.org/project/requests>`__
--   `semver <https://pypi.org/project/semver>`__
+- `python >= 3.10, < 3.14 <https://www.python.org/download/releases>`__
+- `opencolorio <https://pypi.org/project/opencolorio>`__
+- `requests <https://pypi.org/project/requests>`__
+- `semver <https://pypi.org/project/semver>`__
 
 Optional Dependencies
-*********************
+~~~~~~~~~~~~~~~~~~~~~
 
--   `colour-science <https://pypi.org/project/colour-science>`__
--   `graphviz <https://www.graphviz.org>`__
--   `jsonpickle <https://jsonpickle.github.io>`__
--   `networkx <https://pypi.org/project/networkx>`__
--   `pydot <https://pypi.org/project/pydot>`__
+- `colour-science <https://pypi.org/project/colour-science>`__
+- `graphviz <https://www.graphviz.org>`__
+- `jsonpickle <https://jsonpickle.github.io>`__
+- `networkx <https://pypi.org/project/networkx>`__
+- `pydot <https://pypi.org/project/pydot>`__
 
 Docs Dependencies
-*****************
+~~~~~~~~~~~~~~~~~
 
--   `pydata-sphinx-theme <https://pypi.org/project/pydata-sphinx-theme>`__
--   `sphinx <https://pypi.org/project/sphinx>`__
+- `pydata-sphinx-theme <https://pypi.org/project/pydata-sphinx-theme>`__
+- `sphinx <https://pypi.org/project/sphinx>`__
 
 Development Dependencies
-************************
-
--   `coverage <https://pypi.org/project/coverage>`__
--   `coveralls <https://pypi.org/project/coveralls>`__
--   `hatch <https://pypi.org/project/hatch>`__
--   `invoke <https://pypi.org/project/invoke>`__
--   `pre-commit <https://pypi.org/project/pre-commit>`__
--   `pyright <https://pypi.org/project/pyright>`__
--   `pytest <https://pypi.org/project/pytest>`__
--   `pytest-cov <https://pypi.org/project/pytest-cov>`__
--   `pytest-xdist <https://pypi.org/project/pytest-xdist>`__
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+- `coverage <https://pypi.org/project/coverage>`__
+- `coveralls <https://pypi.org/project/coveralls>`__
+- `hatch <https://pypi.org/project/hatch>`__
+- `invoke <https://pypi.org/project/invoke>`__
+- `pre-commit <https://pypi.org/project/pre-commit>`__
+- `pyright <https://pypi.org/project/pyright>`__
+- `pytest <https://pypi.org/project/pytest>`__
+- `pytest-cov <https://pypi.org/project/pytest-cov>`__
+- `pytest-xdist <https://pypi.org/project/pytest-xdist>`__
 
 Components Status
 ^^^^^^^^^^^^^^^^^

docs/conf.py

@@ -6,7 +6,12 @@
 ================================================================
 """
 
-import opencolorio_config_aces as package
+import sys
+from pathlib import Path
+
+sys.path.append(str(Path(__file__).parent.parent))
+
+import opencolorio_config_aces as package  # noqa: E402
 
 basename = package.__name__.replace("_", "-")
 
@@ -23,7 +28,7 @@
     "sphinx.ext.mathjax",
 ]
 
-intersphinx_mapping = {"python": ("https://docs.python.org/3.8", None)}
+intersphinx_mapping = {"python": ("https://docs.python.org/3.13", None)}
 
 autosummary_generate = True
 
@@ -36,7 +41,7 @@
 master_doc = "index"
 
 project = package.__application_name__
-copyright = package.__copyright__.replace("Copyright (C)", "")  # noqa: A001
+copyright = package.__copyright__  # noqa: A001
 version = f"{package.__major_version__}.{package.__minor_version__}"
 release = package.__version__
 

docs/installation.rst

@@ -38,7 +38,7 @@ The *aces-dev* *CTL* reference graph can be plotted but it requires `Graphviz <h
 to be installed on the system.
 
 Docker
-------
+~~~~~~
 
 Installing the dependencies for the `previous config generator <https://github.com/imageworks/OpenColorIO-Configs>`__
 was not a trivial task. For ease of use an `aswf-docker <https://github.com/AcademySoftwareFoundation/aswf-docker>`__
@@ -59,43 +59,43 @@ Then, to run *bash* in the container::
     docker run -it -v ${PWD}:/home/aswf/OpenColorIO-Config-ACES aswf/opencolorio-config-aces:latest /bin/bash
 
 Pypi
-----
+~~~~
 
 The **OpenColorIO Configuration for ACES** package requires various
 dependencies in order to run and be able to generate the *OCIO* configurations:
 
 Primary Dependencies
-********************
+~~~~~~~~~~~~~~~~~~~~
 
--   `python >= 3.10, < 3.14 <https://www.python.org/download/releases>`__
--   `opencolorio <https://pypi.org/project/opencolorio>`__
--   `requests <https://pypi.org/project/requests>`__
--   `semver <https://pypi.org/project/semver>`__
+- `python >= 3.10, < 3.14 <https://www.python.org/download/releases>`__
+- `opencolorio <https://pypi.org/project/opencolorio>`__
+- `requests <https://pypi.org/project/requests>`__
+- `semver <https://pypi.org/project/semver>`__
 
 Optional Dependencies
-*********************
+~~~~~~~~~~~~~~~~~~~~~
 
--   `colour-science <https://pypi.org/project/colour-science>`__
--   `graphviz <https://www.graphviz.org>`__
--   `jsonpickle <https://jsonpickle.github.io>`__
--   `networkx <https://pypi.org/project/networkx>`__
--   `pydot <https://pypi.org/project/pydot>`__
+- `colour-science <https://pypi.org/project/colour-science>`__
+- `graphviz <https://www.graphviz.org>`__
+- `jsonpickle <https://jsonpickle.github.io>`__
+- `networkx <https://pypi.org/project/networkx>`__
+- `pydot <https://pypi.org/project/pydot>`__
 
 Docs Dependencies
-*****************
+~~~~~~~~~~~~~~~~~
 
--   `pydata-sphinx-theme <https://pypi.org/project/pydata-sphinx-theme>`__
--   `sphinx <https://pypi.org/project/sphinx>`__
+- `pydata-sphinx-theme <https://pypi.org/project/pydata-sphinx-theme>`__
+- `sphinx <https://pypi.org/project/sphinx>`__
 
 Development Dependencies
-************************
-
--   `coverage <https://pypi.org/project/coverage>`__
--   `coveralls <https://pypi.org/project/coveralls>`__
--   `hatch <https://pypi.org/project/hatch>`__
--   `invoke <https://pypi.org/project/invoke>`__
--   `pre-commit <https://pypi.org/project/pre-commit>`__
--   `pyright <https://pypi.org/project/pyright>`__
--   `pytest <https://pypi.org/project/pytest>`__
--   `pytest-cov <https://pypi.org/project/pytest-cov>`__
--   `pytest-xdist <https://pypi.org/project/pytest-xdist>`__
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+- `coverage <https://pypi.org/project/coverage>`__
+- `coveralls <https://pypi.org/project/coveralls>`__
+- `hatch <https://pypi.org/project/hatch>`__
+- `invoke <https://pypi.org/project/invoke>`__
+- `pre-commit <https://pypi.org/project/pre-commit>`__
+- `pyright <https://pypi.org/project/pyright>`__
+- `pytest <https://pypi.org/project/pytest>`__
+- `pytest-cov <https://pypi.org/project/pytest-cov>`__
+- `pytest-xdist <https://pypi.org/project/pytest-xdist>`__

docs/opencolorio_config_aces.clf.rst

@@ -12,11 +12,11 @@ Common LUT Format Discovery
 .. autosummary::
     :toctree: generated/
 
-    classify_clf_transforms
     discover_clf_transforms
+    classify_clf_transforms
+    unclassify_clf_transforms
     filter_clf_transforms
     print_clf_taxonomy
-    unclassify_clf_transforms
 
 Common LUT Format Generation
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~

docs/opencolorio_config_aces.config.rst

@@ -16,7 +16,7 @@ Version Utilities
     :toctree: generated/
 
     PROFILE_VERSION_DEFAULT
-    SUPPORTED_PROFILE_VERSIONS
+    PROFILE_VERSIONS
 
 Build Configuration Utilities
 -----------------------------
@@ -28,9 +28,9 @@ Build Configuration Utilities
 .. autosummary::
     :toctree: generated/
 
-    BuildConfiguration
     BUILD_CONFIGURATIONS
     BUILD_VARIANT_FILTERERS
+    BuildConfiguration
 
 Config Generation Common Objects
 --------------------------------
@@ -115,7 +115,6 @@ Reference Configuration
     :toctree: generated/
 
     DescriptionStyle
-    version_config_mapping_file
     generate_config_aces
 
 *ACES* Computer Graphics (CG) Config Generator
@@ -141,3 +140,13 @@ Reference Configuration
     :toctree: generated/
 
     generate_config_studio
+
+Generation Utilities
+~~~~~~~~~~~~~~~~~~~~
+
+``opencolorio_config_aces``
+
+.. autosummary::
+    :toctree: generated/
+
+    BUILTIN_TRANSFORMS

docs/opencolorio_config_aces.utilities.rst

@@ -33,7 +33,6 @@ Common
     git_describe
     matrix_3x3_to_4x4
     multi_replace
-    regularise_version
     validate_method
     google_sheet_title
     slugify

opencolorio_config_aces/__init__.py

@@ -32,9 +32,12 @@
 )
 from .config import (
     BUILTIN_TRANSFORMS,
+    BUILD_CONFIGURATIONS,
+    BUILD_VARIANT_FILTERERS,
     ConfigData,
     PROFILE_VERSION_DEFAULT,
     PROFILE_VERSIONS,
+    BuildConfiguration,
     deserialize_config_data,
     generate_config,
     serialize_config_data,
@@ -48,6 +51,7 @@
     discover_aces_ctl_transforms,
     filter_ctl_transforms,
     filter_nodes,
+    generate_amf_components,
     node_to_ctl_transform,
     plot_aces_conversion_graph,
     print_aces_taxonomy,
@@ -87,9 +91,12 @@
 ]
 __all__ += [
     "BUILTIN_TRANSFORMS",
+    "BUILD_CONFIGURATIONS",
+    "BUILD_VARIANT_FILTERERS",
     "ConfigData",
     "PROFILE_VERSION_DEFAULT",
     "PROFILE_VERSIONS",
+    "BuildConfiguration",
     "deserialize_config_data",
     "generate_config",
     "serialize_config_data",
@@ -103,6 +110,7 @@
     "discover_aces_ctl_transforms",
     "filter_ctl_transforms",
     "filter_nodes",
+    "generate_amf_components",
     "node_to_ctl_transform",
     "plot_aces_conversion_graph",
     "print_aces_taxonomy",

opencolorio_config_aces/config/__init__.py

@@ -14,6 +14,7 @@
 from .generation import (
     BUILTIN_TRANSFORMS,
     BUILD_CONFIGURATIONS,
+    BUILD_VARIANT_FILTERERS,
     ConfigData,
     PROFILE_VERSION_DEFAULT,
     PROFILE_VERSIONS,
@@ -58,6 +59,7 @@
 __all__ += [
     "BUILTIN_TRANSFORMS",
     "BUILD_CONFIGURATIONS",
+    "BUILD_VARIANT_FILTERERS",
     "ConfigData",
     "PROFILE_VERSION_DEFAULT",
     "PROFILE_VERSIONS",