Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replace auto-generation of website test image with explicit sidecar jpg files #1667

Merged
merged 1 commit into from
Mar 18, 2024

Conversation

cary-ilm
Copy link
Member

@cary-ilm cary-ilm commented Mar 10, 2024

Automatically generating .jpg images for display under "Test Images" as a step in building the website seemed like a good idea a the time, but is too hard to maintain. I couldn't get the process to work across Linux, macOS, and Windows, which means no Windows/macOS-based developers can contribute to the website.

The https://github.com/AcademySoftwareFoundation/openexr-images repo now has a permenant sidecar .jpg file associated with each .exr which serves as a proxy for display on the website.

The website/scripts/test_images.py is still in place but is now to be run manually to generate the website .rst and the associated .rst files describing each image. Anyone providing additional test images to theopenexr-image repo should contribute an associated .jpg for display.

To contribute additional images, first add the images to the image repo, then run the website/scripts/test_image.py, and commit the new/modified .rst files(s).

Website preview: https://openexr--1667.org.readthedocs.build/en/1667/

Automatically generating .jpg images for display under "Test Images"
as a step in building the website seemed like a good idea a the time,
but is too hard to maintain. I couldn't get the process to work across
Linux, macOS, and Windows, which means no Windows/macOS-based
developers can contribute to the website.

The https://github.com/AcademySoftwareFoundation/openexr-images repo
now has a permenant sidecar .jpg file associated with each .exr which
serves as a proxy for display on the website.

The `website/scripts/test_images.py` is still in place but is now to
be run manually to generate the website `.rst` and the associated
`.rst` files describing each image. Anyone providing additional test
images to the`openexr-image` repo should contribute an associated
`.jpg` for display.

To contribute additional images, first add the images to the image
repo, then run the `website/scripts/test_image.py`, and commit the
new/modified `.rst` files(s).

Signed-off-by: Cary Phillips <cary@ilm.com>
@cary-ilm cary-ilm merged commit 7b1556b into AcademySoftwareFoundation:main Mar 18, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant