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

#1545 Fix formatting of sample exr file in OpenEXRFileLayout.rst - 3rd attempt #1587

Conversation

annguyen-ilm
Copy link
Contributor

  • Making a pull request from the feature branch of my forked repro. This allows me to sync the main branch of my forked repro to sync any updates from the root repro.

  • After syncing the root repro into my fork main branch. Rebase my feature branch with main to pick up the updates. Resolve any conflicts which resolved the typo commit in README.md, as in removed that commit.

  • Move the download link of the sample.exr above the table.

  • Update the paragraph above the table to describe the table columns instead of the rows of the old code blocks.

  • Minor housekeeping, moving the sample.exr to the website/downloads to keep it consistent with the build/website/sphinx/_downloads directory. To avoid confusion for future additions to downloads etc.

…with bytes of the sample file in one column. The value in the second column and the third column being the description of the bytes and value.

Signed-off-by: An Nguyen <annguyen@ilm.com>
* Gave the table a title and reduce the width to 50%

Signed-off-by: An Nguyen <annguyen@ilm.com>
…ndow value

Signed-off-by: An Nguyen <annguyen@ilm.com>
Signed-off-by: An Nguyen <annguyen@ilm.com>
…learer.

Signed-off-by: An Nguyen <annguyen@ilm.com>
Signed-off-by: An Nguyen <annguyen@ilm.com>
Signed-off-by: An Nguyen <annguyen@ilm.com>
…the table to describe the table

Signed-off-by: An Nguyen <annguyen@ilm.com>
…arget destination naming scheme to avoid confusion where the files go when built

Signed-off-by: An Nguyen <annguyen@ilm.com>
@cary-ilm
Copy link
Member

Thanks for getting this sorted out! Do you have a link to the output html on your readthedocs? There were a few anomalies in the previous iteration I wanted to comment on, but it looks like it's gone away.

website/OpenEXRFileLayout.rst Outdated Show resolved Hide resolved
website/OpenEXRFileLayout.rst Outdated Show resolved Hide resolved
website/OpenEXRFileLayout.rst Outdated Show resolved Hide resolved
website/OpenEXRFileLayout.rst Outdated Show resolved Hide resolved
website/OpenEXRFileLayout.rst Outdated Show resolved Hide resolved
website/OpenEXRFileLayout.rst Outdated Show resolved Hide resolved
website/OpenEXRFileLayout.rst Outdated Show resolved Hide resolved
website/OpenEXRFileLayout.rst Outdated Show resolved Hide resolved
website/OpenEXRFileLayout.rst Outdated Show resolved Hide resolved
Signed-off-by: An Nguyen <annguyen@ilm.com>
@annguyen-ilm
Copy link
Contributor Author

https://openexr-annguyen.readthedocs.io/en/latest/OpenEXRFileLayout.html#sample-file
is the link to my readthedocs that get built on my branch/main.

@cary-ilm
Copy link
Member

This looks better, thanks! I've been busy on other things and I'd like to take a deeper look at it, but I won't have time to get to it until the first week of December.

Copy link
Member

@cary-ilm cary-ilm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good as is, thanks!

@cary-ilm cary-ilm merged commit defea17 into AcademySoftwareFoundation:main Dec 18, 2023
3 checks passed
cary-ilm pushed a commit to cary-ilm/openexr that referenced this pull request Feb 13, 2024
…penEXRFileLayout.rst - 3rd attempt (AcademySoftwareFoundation#1587)

* Replaced the sample exr file code blocks with a grid table formatted with bytes of the sample file in one column. The value in the second column and the third column being the description of the bytes and value.

Signed-off-by: An Nguyen <annguyen@ilm.com>

* * Updated so the ascii values for the bytes are aligned to each byte.
* Gave the table a title and reduce the width to 50%

Signed-off-by: An Nguyen <annguyen@ilm.com>

* Added missing 4 bytes missing from the dataWindow value and displayWindow value

Signed-off-by: An Nguyen <annguyen@ilm.com>

* Added the sample.exr file

Signed-off-by: An Nguyen <annguyen@ilm.com>

* Annotated the attribute values more for the header. Should be a bit clearer.

Signed-off-by: An Nguyen <annguyen@ilm.com>

* Adding the sample.exr file was documented.

Signed-off-by: An Nguyen <annguyen@ilm.com>

* Added download link to the sample.exr file.

Signed-off-by: An Nguyen <annguyen@ilm.com>

* Move the download link above the table. Updated the paragraph before the table to describe the table

Signed-off-by: An Nguyen <annguyen@ilm.com>

* Move the sample.exr image into the downloads directory to match the target destination naming scheme to avoid confusion where the files go when built

Signed-off-by: An Nguyen <annguyen@ilm.com>

* Updated the table to annotate the type and literal as type.

Signed-off-by: An Nguyen <annguyen@ilm.com>

---------

Signed-off-by: An Nguyen <annguyen@ilm.com>
cary-ilm pushed a commit that referenced this pull request Feb 16, 2024
…d attempt (#1587)

* Replaced the sample exr file code blocks with a grid table formatted with bytes of the sample file in one column. The value in the second column and the third column being the description of the bytes and value.

Signed-off-by: An Nguyen <annguyen@ilm.com>

* * Updated so the ascii values for the bytes are aligned to each byte.
* Gave the table a title and reduce the width to 50%

Signed-off-by: An Nguyen <annguyen@ilm.com>

* Added missing 4 bytes missing from the dataWindow value and displayWindow value

Signed-off-by: An Nguyen <annguyen@ilm.com>

* Added the sample.exr file

Signed-off-by: An Nguyen <annguyen@ilm.com>

* Annotated the attribute values more for the header. Should be a bit clearer.

Signed-off-by: An Nguyen <annguyen@ilm.com>

* Adding the sample.exr file was documented.

Signed-off-by: An Nguyen <annguyen@ilm.com>

* Added download link to the sample.exr file.

Signed-off-by: An Nguyen <annguyen@ilm.com>

* Move the download link above the table. Updated the paragraph before the table to describe the table

Signed-off-by: An Nguyen <annguyen@ilm.com>

* Move the sample.exr image into the downloads directory to match the target destination naming scheme to avoid confusion where the files go when built

Signed-off-by: An Nguyen <annguyen@ilm.com>

* Updated the table to annotate the type and literal as type.

Signed-off-by: An Nguyen <annguyen@ilm.com>

---------

Signed-off-by: An Nguyen <annguyen@ilm.com>
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.

2 participants