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

Restore logo to ReadTheDocs pages #2036

Open
doug-walker opened this issue Sep 5, 2024 · 4 comments
Open

Restore logo to ReadTheDocs pages #2036

doug-walker opened this issue Sep 5, 2024 · 4 comments
Labels
Build Issue Issues related to build or environment problems on any platform. Documentation Documentation related development and/or updates. good first issue Standard label for new developers to locate good issues to tackle to learn about OCIO development. help wanted Issues that the TSC has decided are worth implementing, but don't currently have the dev resources.

Comments

@doug-walker
Copy link
Collaborator

doug-walker commented Sep 5, 2024

Adding the config file (.readthedocs.yml) got our ReadTheDocs site building again, after being broken for a while. However, it is now created using Sphinx 7.1.2 and Press Theme 0.9.1 and that has broken some things. Most prominently, the OCIO logo in the top left corner is gone and replaced with the word "logo". There may be other stuff broken too.

To see the issue, use the menu in the lower right corner of the RTD pages to switch from "v: latest" to an earlier version.

EDIT: Per the comments below, the logo does seem to be loading now. But for people running in "dark mode", it's a black logo against an almost black screen. We should be using the magenta OCIO logo since it will be visible in either light or dark mode.

If people notice any other aesthetic issues likely due to the infrastructure version updates, please note them in the comments below.

@doug-walker doug-walker added Documentation Documentation related development and/or updates. good first issue Standard label for new developers to locate good issues to tackle to learn about OCIO development. help wanted Issues that the TSC has decided are worth implementing, but don't currently have the dev resources. Build Issue Issues related to build or environment problems on any platform. labels Sep 5, 2024
@shaneantrim
Copy link
Contributor

Hey @doug-walker, I'm clicking on all of the previous versions on the main OCIO RTD page (https://opencolorio.readthedocs.io/en/latest/#) and the logo appears ok in the top-left unless I'm missing something?

@doug-walker
Copy link
Collaborator Author

@shaneantrim , well the logo is now loading for me too. Not sure what was going on there. However, I'm going to leave the issue open and edit the description. The problem now is that if the browser is running in "dark mode" it results in a black logo on an almost black page. We should be using the magenta OCIO logo.

@shaneantrim
Copy link
Contributor

shaneantrim commented Sep 9, 2024

Hey @doug-walker, I'm interested in working on this. Can you confirm in what folder the code for this lives and in what language it is written in? I'm assuming this is HTML and CSS?

@doug-walker
Copy link
Collaborator Author

@shaneantrim , I didn't create the original RTD pages, so I'm not actually sure which image is being pulled from the various ones in the docs directory (there are several OCIO .png and .svg files). Perhaps @carolalynn or @scooperly knows?

There is some documentation here about how the RTD pages are generated.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Build Issue Issues related to build or environment problems on any platform. Documentation Documentation related development and/or updates. good first issue Standard label for new developers to locate good issues to tackle to learn about OCIO development. help wanted Issues that the TSC has decided are worth implementing, but don't currently have the dev resources.
Projects
None yet
Development

No branches or pull requests

2 participants