Update doc footer per #205

Also update the doc build script to use `uv` if present. That's nicer
because you don't have to manually create a python venv or install
depencies.
Removed old unused footer, and marked ofx-header and ofx-footer as unused.

Signed-off-by: Gary Oberbrunner <[email protected]>

Author: garyo

Documentation/build.sh

@@ -22,37 +22,44 @@ if [ ! -f genPropertiesReference.py ] ; then
     exit 1
 fi
 
-if ! command -v sphinx-build > /dev/null 2>&1 ; then
-    echo "Python can't import required modules; did you set up the prereqs?"
-    echo "Check the README.md."
-    exit 1
+if command -v uvx > /dev/null 2>&1; then
+    USE_UV=1
+    SPHINX_BUILD="uv run --with-requirements pipreq.txt sphinx-build"
+    UV_RUN="uv run"
+else
+    USE_UV=
+    SPHINX_BUILD="sphinx-build"
+    UV_RUN=""
 fi
 
 rm -rf build
 
 # Generate references
 EXPECTED_ERRS="unable to resolve reference|explicit link request|found in multiple"
-python genPropertiesReference.py \
+$UV_RUN python genPropertiesReference.py \
        -i ../include -o sources/Reference/ofxPropertiesReference.rst -r \
        > /tmp/ofx-doc-build.out 2>&1
-egrep -v "$EXPECTED_ERRS" /tmp/ofx-doc-build.out || true
+grep -v -E "$EXPECTED_ERRS" /tmp/ofx-doc-build.out || true
 
 # Build the Doxygen docs
 EXPECTED_ERRS="malformed hyperlink target|Duplicate explicit|Definition list ends|unable to resolve|could not be resolved"
 cd ../include
 doxygen ofx.doxy > /tmp/ofx-doc-build.out 2>&1
-egrep -v "$EXPECTED_ERRS" /tmp/ofx-doc-build.out || true
+grep -v -E "$EXPECTED_ERRS" /tmp/ofx-doc-build.out || true
 cd -
 
 # Use breathe.apidoc to collect the Doxygen API docs
 rm -rf sources/Reference/api
-python -m breathe.apidoc -p 'ofx_reference' -m --force -g class,interface,struct,union,file,namespace,group -o sources/Reference/api doxygen_build/xml
-
+if [[ $USE_UV ]]; then
+    $UV_RUN --with breathe python -m breathe.apidoc -p 'ofx_reference' -m --force -g class,interface,struct,union,file,namespace,group -o sources/Reference/api doxygen_build/xml
+else
+    python -m breathe.apidoc -p 'ofx_reference' -m --force -g class,interface,struct,union,file,namespace,group -o sources/Reference/api doxygen_build/xml
+fi
 
 # Build the Sphinx docs
 EXPECTED_ERRS='Explicit markup ends without|Duplicate C.*declaration|Declaration is|cpp:func targets a member|undefined label'
-sphinx-build -b html sources build > /tmp/ofx-doc-build.out 2>&1
-egrep -v "$EXPECTED_ERRS" /tmp/ofx-doc-build.out || true
+$SPHINX_BUILD -b html sources build > /tmp/ofx-doc-build.out 2>&1
+grep -v -E "$EXPECTED_ERRS" /tmp/ofx-doc-build.out || true
 
 echo "Documentation build complete."
 echo "Open file:///$PWD/build/index.html in your browser"

Documentation/genPropertiesReference.py

@@ -1,6 +1,6 @@
 # SPDX-License-Identifier: BSD-3-Clause
 
-import os,sys, getopt,re
+import os,sys,getopt
 
 badlyNamedProperties = ["kOfxImageEffectFrameVarying", "kOfxImageEffectPluginRenderThreadSafety"]
 

Documentation/sources/Reference/ofxPropertiesReference.rst

@@ -47,17 +47,7 @@ Properties Reference
 
 .. doxygendefine:: kOfxImageEffectPropColourManagementAvailableConfigs
 
-.. doxygendefine:: kOfxImageEffectColourManagementBasic
-
-.. doxygendefine:: kOfxImageEffectColourManagementConfig
-
-.. doxygendefine:: kOfxImageEffectColourManagementCore
-
-.. doxygendefine:: kOfxImageEffectColourManagementFull
-
-.. doxygendefine:: kOfxImageEffectColourManagementNone
-
-.. doxygendefine:: kOfxImageEffectColourManagementOCIO
+.. doxygendefine:: kOfxImageEffectPropColourManagementConfig
 
 .. doxygendefine:: kOfxImageEffectPropColourManagementStyle
 
@@ -93,6 +83,8 @@ Properties Reference
 
 .. doxygendefine:: kOfxImageEffectPropMetalRenderSupported
 
+.. doxygendefine:: kOfxImageEffectPropNoSpatialAwareness
+
 .. doxygendefine:: kOfxImageEffectPropOCIOConfig
 
 .. doxygendefine:: kOfxImageEffectPropOCIODisplay

Documentation/sources/conf.py

@@ -11,9 +11,10 @@
 
 import subprocess, os, shutil
 project = 'OpenFX'
-copyright = '2024, Contributors to the OpenFX Project'
+copyright = '''2025, OpenFX a Series of LF Projects, LLC.
+For web site terms of use, trademark policy and other project policies please see https://lfprojects.org/'''
 author = 'Contributors to the OpenFX Project'
-release = '1.4'
+release = '1.5'
 
 read_the_docs_build = os.environ.get('READTHEDOCS', None) == 'True'
 # -- General configuration ---------------------------------------------------

include/DocSrc/footer.html

@@ -1,4 +1,5 @@
 <!-- HTML footer for doxygen 1.8.6-->
+<!-- NOTE: this is not used in OpenFX. Final docs are generated via sphinx. -->
 <!-- start footer part -->
 <!--BEGIN GENERATE_TREEVIEW-->
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->

include/DocSrc/ofx_footer.html

@@ -1,4 +1,5 @@
 <!-- HTML header for doxygen 1.8.6-->
+<!-- NOTE: this is not used in OpenFX. Final docs are generated via sphinx. -->
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 <html xmlns="http://www.w3.org/1999/xhtml">
 <head>

include/DocSrc/ofx_header.html

@@ -32,13 +32,13 @@ DOXYFILE_ENCODING      = UTF-8
 # title of most generated pages and in a few other places.
 # The default value is: My Project.
 
-PROJECT_NAME           = "OFX"
+PROJECT_NAME           = "OpenFX"
 
 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = "1.4+"
+PROJECT_NUMBER         = "1.5+"
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a