RTD render doesn't show a .svg logo?

[goodboy]

Describe the problem

A readthedocs render doesn't seem to show an .svg logo?

Not sure where to look for the root cause of this.
Could it be some kind of rtd config we're missing?

A manual inspection of a local html versus rtd shows differences in the tree.

Link to your repository or website

https://tractor.readthedocs.io/en/latest/

Steps to reproduce

We're expecting it to look like:

The version of Python you're using

3.9

Your operating system

linux

Versions of your packages

No response

Additional context

I'll put up the html diff of interest if needed?

[goodboy]

Yeah this entire section seems to be missing from rtd version?

<div class="col-12 col-md-3 bd-sidebar site-navigation show" id="site-navigation">
    
        <div class="navbar-brand-box">
<a class="navbar-brand text-wrap" href="#">
  
  <img src="_static/tractor_logo_side.svg" class="logo" alt="logo">
  
  
  <h1 class="site-logo" id="site-title">structured concurrent Python</h1>
  
</a>
</div>

[chrisjsewell]

Possibly related to #364 (comment)

when you say it doesn’t show for svg, is this because it does show for other image formats?

[goodboy]

when you say it doesn’t show for svg, is this because it does show for other image formats?

Haven't tried other formats, so no, just providing the data point.

Ok so logo_url is the issue?

I'll give that a shot.

[chrisjsewell]

Ok so logo_url is the issue?

well it shouldn't be in principle, since you are not using sphinx v4, but can always give it a try.

I'd note that I was literally just adding a new SVG logo to some of our other documentation, and this seems to be working ok:

• executablebooks/jupyter-cache@3519065
• https://jupyter-cache--74.org.readthedocs.build/en/74/

[goodboy]

https://jupyter-cache--74.org.readthedocs.build/en/74/

Lol indeed it seems to be there.
This is not rtd top level domain though right?

[goodboy]

Yah config for you:
executablebooks/jupyter-cache@3519065#diff-85933aa74a2d66c3e4dcdf7a9ad8397f5a7971080d34ef1108296a7c6b69e7e3R63

Looks the same as ours?
https://github.com/goodboy/tractor/blob/master/docs/conf.py#L91

Oddly the favicon looks fine?

Hmm I wonder if it's because it doesn't have html_title set?

[goodboy]

Oh wait, this is what I see on https://jupyter-cache--74.org.readthedocs.build/en/74/

Not sure if it's missing something?

[chrisjsewell]

Yep I have "logo_only": True in the html_theme_options, so no html title will show

One other thing I noticed, that may not have any relevance here, but you don't use an RTD configuration file e.g. https://github.com/executablebooks/jupyter-cache/blob/master/.readthedocs.yml

[pradyunsg]

What version of Sphinx are you building with? ReadTheDocs defaults to shipping with Sphinx 1.8, which... might be the culprit here?

[choldgraf]

I believe that this is because you're using a custom html_sidebars variable, and not including the sidebar-logo.html in there:

https://github.com/goodboy/tractor/blob/26bebc42b7d654c7873e50d76eeb72c0a7d7cdd0/docs/conf.py#L64-L85

See these docs for the stuff you can include: https://sphinx-book-theme.readthedocs.io/en/latest/customize/sidebar-primary.html#default-sidebar-elements

closing this as I think it's a config issue, not a bug in the theme