Restore logo to ReadTheDocs pages
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.
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?
@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.
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?
@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.
For ReadTheDocs I believe it's only looking at the _static/ocio_b.svg file - config is https://github.com/AcademySoftwareFoundation/OpenColorIO/blob/main/docs/conf.py#L139
while for the homepage the magenta logo is site/homepage/static/images/ocio_m2x.png configured here:
https://github.com/AcademySoftwareFoundation/OpenColorIO/blob/main/docs/site/homepage/config.toml#L93
EDIT: and here's the ocio_b.svg patched with the fill to be #cc1e68 which was what I got from a quick sample of the PNG
EDIT EDIT: Let me just inline the SVG š
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 145.88 43.66"><defs><style>.cls-1{fill:#cc1e68;}</style></defs><title>ocio_m</title><g id="Layer_2" data-name="Layer 2"><g id="Layer_1-2" data-name="Layer 1"><path class="cls-1" d="M75.67,18.35l11.16-3.71,0-.14a21.42,21.42,0,0,0-2-4.13l-.08-.12-10,6.46A9.16,9.16,0,0,1,75.67,18.35Z"/><path class="cls-1" d="M88,19.73l0-.14L76.38,21.06a9.12,9.12,0,0,1,0,1.92l11.56,1.47,0-.14a21.74,21.74,0,0,0,0-4.58Z"/><path class="cls-1" d="M74.7,27.37l9.89,6.56.08-.12a21.44,21.44,0,0,0,2-4.1l0-.14L75.64,25.73A9.16,9.16,0,0,1,74.7,27.37Z"/><circle class="cls-1" cx="67.25" cy="22.01" r="5"/><path class="cls-1" d="M76.1,32.35a13.61,13.61,0,1,1,.12-20.57l5.93-5.46A21.65,21.65,0,1,0,82,37.81Z"/><path class="cls-1" d="M21.64,0A21.64,21.64,0,1,0,43.28,21.66,21.64,21.64,0,0,0,21.64,0Zm0,35.25A13.61,13.61,0,1,1,35.25,21.66,13.61,13.61,0,0,1,21.64,35.26Z"/><path class="cls-1" d="M124.24,0a21.64,21.64,0,1,0,21.64,21.64A21.64,21.64,0,0,0,124.24,0Zm0,35.25a13.61,13.61,0,1,1,13.61-13.61A13.61,13.61,0,0,1,124.24,35.25Z"/><rect class="cls-1" x="91.71" y="3.85" width="8.01" height="35.57"/></g></g></svg>
Ahh, found the broken logo just now:
ā https://opencolorio.readthedocs.io/en/latest/guides/authoring/authoring.html - it's looking for _static/ocio_b.svg ā https://opencolorio.readthedocs.io/en/latest/ looking for en/latest/_static/ocio_b.svg
Good morning! I stumbled upon this issue and found it really funny! @tanant shared a couple of great leads here. If no one has claimed it yet, Iād love to play around with it during Dev Day and see if I can push it further.
Just to recap what needs to be done here:
- Replace the current black logo with the magenta version
- Ensure the logo appears when navigating away from the home page
Excellent, assigning to you @irwang-dwa !