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

Fix width formatting in RIPMAP_LEVELS table in TechnicalIntroduction.rst #1551

Open
cary-ilm opened this issue Sep 11, 2023 · 8 comments
Open
Labels
Documentation Developer guide, web site, project policies, etc. Good first issue Possible one-day project for somebody new

Comments

@cary-ilm
Copy link
Member

The table illustrating RIPMAP_LEVELS has a typo in the formatting of the width: it should be .. centered:: (there's a missing colon :).

This task requires some basic familiarity with reStructuredText and sphinx but the concepts are easy to pick up from other examples. See Building the Website for how to test the formatting.

@cary-ilm cary-ilm added Documentation Developer guide, web site, project policies, etc. Good first issue Possible one-day project for somebody new labels Sep 11, 2023
@ruiyang2021
Copy link

Hi, wondering if I can take a look at this issue for Dev Days. I see there's a linked pull request under Minlestones, but it doesn't link to anything when I click on it. Is this issue still valid?
image

@cary-ilm
Copy link
Member Author

I have no idea what the link under Milestones is, I don't see any mention of this in any recent PR's, so it should still be open. Please have at it!

@ruiyang2021
Copy link

Thanks, Cary!
Can I get some help with https://openexr.com/en/latest/install.html#building-the-website? I'm on windows using git bash and cmake ui. I got the dependencies. Cmake has some warnings about Imath and libdeflate and says it's installing them. Sounds like it's good here. Following the part about "Building the Website", cmake .. -DBUILD_WEBSITE=ON seems okay. Then cmake --build . --target website gives this

E:\devdays\openexr\build>cmake --build . --target website
MSBuild version 17.3.0+f67e3d35e for .NET Framework
  Running doxygen
  Generating test image pages
  %1 is not a valid Win32 application
C:\Program Files\Microsoft Visual Studio\2022\Community\MSBuild\Microsoft\VC\v170\Microsoft.CppCommon.targets(247,5): error MSB8066: Custom build for 'E:\devdays\openexr\website\Doxyfile.in;E:\devdays\openexr\build\CMakeFiles\c3152c30a40b569a3efe05c31097f728\index.rst.rule;E:\devdays\openexr\build\CMakeFiles\b2d3be5298683ed7e04330859653c62d\index.html.rule;E:\devdays\openexr\build\CMakeFiles\e5d5900e5ad15c837a0c50e9bda0ccd4\website.rule' exited with code 1. [E:\devdays\openexr\build\website\website.vcxproj]

Not sure what I got wrong.

@ruiyang2021
Copy link

ruiyang2021 commented Oct 13, 2023

Cary pointed out in #devdays chat that "it’s failing on the step that downloads images from the image repo and converts them to jpg". "You might try just commenting out anything in the cmake file and the .rst having anything to do with the test image gallery."

So I did more investigation today, here are some thoughts:

  1. If I commented out everything that error out, it can build successfully, but won't generate the html file in openexr\build\website\doxygen\html, which, I suppose, must be the website I'm looking for.

  2. With cmake --build . --target website, the test image error is somewhat related to https://github.com/AcademySoftwareFoundation/openexr/blob/main/website/CMakeLists.txt#L29, my _test_images folder is empty.

  3. However, there is a index.rst file in openexr/website . If I set my TEST_IMAGE_INDEX_FILE to it. I'll get another error:

CUSTOMBUILD : Warning, treated as error : [E:\devdays\openexr\build\website\website.vcxproj]
  E:\devdays\openexr\website\OpenEXRCoreAPI.rst:207:doxygenfunction: Cannot find function "exr_set_default_maximum_image_size" in doxygen xml output for project "OpenEXR" from directory: E:/devdays/openexr/build/website/doxygen/xml
C:\Program Files\Microsoft Visual Studio\2022\Community\MSBuild\Microsoft\VC\v170\Microsoft.CppCommon.targets(247,5): error MSB8066: Custom build for 'E:\devdays\openexr\website\Doxyfile.in;E:\devdays\openexr\build\CMakeFiles\b2d3be5298683ed7e04330859653c62d\index.html.rule;E:\devdays\openexr\build\CMakeFiles\e5d5900e5ad15c837a0c50e9bda0ccd4\website.rule' exited with code 2. [E:\devdays\openexr\build\website\website.vcxproj]

Indeed I don't have any xml files start with exr_ in my openexr/build/website/doxygen/xml . Not sure how I can get them

@cary-ilm
Copy link
Member Author

Sorry about this confusion, it looks like it's a challenge to build the website in windows. You might just try commenting out anything that's leading to errors, especially the test image gallery stuff, if it's unrelated to the changes you'd like to make. Then just don't comment the commented-out files.

@ruiyang2021
Copy link

ruiyang2021 commented Oct 13, 2023

Thanks for all the help!

To elaborate more on issue 1, I mean, if I commented out everything that error out, it can build successfully, but won't generate the html file. The message in the console is:

  build succeeded.
  The HTML pages are in sphinx.
C:\Program Files\Microsoft Visual Studio\2022\Community\MSBuild\Microsoft\VC\v170\Microsoft.CppCommon.targets(247,5): warning MSB8065: Custom build for item "E:\devdays\openexr\website\Doxyfile.in" succeeded, but specified output "e:\devdays\openexr\build\website\doxygen\html\index.html" has not been created. This may cause incremental build to work incorrectly. [E:\devdays\openexr\build\website\website.vcxproj]
C:\Program Files\Microsoft Visual Studio\2022\Community\MSBuild\Microsoft\VC\v170\Microsoft.CppCommon.targets(247,5): warning MSB8064: Custom build for item "E:\devdays\openexr\build\CMakeFiles\b2d3be5298683ed7e04330859653c62d\index.html.rule" succeeded, but specified dependency "e:\devdays\openexr\build\website\doxygen\html\index.html" does not exist. This may cause incremental build to work incorrectly. [E:\devdays\openexr\build\website\website.vcxproj]

I think, that e:\devdays\openexr\build\website\doxygen\html\index.html file is the website that gets built, where I can test changes with, right? Or is there anywhere else I should be looking for?

I think, the erroring part is prob related to the generation of the website. The message above mentioned index.html, whereas issue 2 (https://github.com/AcademySoftwareFoundation/openexr/blob/main/website/CMakeLists.txt#L29) is about looking for a index.rst file that doesn't exist. From here, we can circle back to issue 2 and issue 3

Maybe I still need to sort out some of the erroring part, so that I can get to see how the website looks like when it picks up my changes

@ruiyang2021
Copy link

Thanks for all the help I received during the two devdays! Unfortunately, I couldn't sort out these issues. The situation is prob similar to 1550. "Build from Source" works, but "Build the Website" doesn't seem so.

I may be able to check back in later days, but can't guarantee. Anyone gets interested and is able to get to this before me, feel free to pick this up, cheers.

@cary-ilm
Copy link
Member Author

Thanks for the efforts! It looks like the script to generate the images for the test image gallery doesn't function properly on Windows. That needs to be resolved before attempting to make any changes to the website on a Windows machine. Track this issue at #1580.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Developer guide, web site, project policies, etc. Good first issue Possible one-day project for somebody new
Projects
None yet
Development

No branches or pull requests

2 participants