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

logo is not display in the "latest" version of the doc #1130

Closed
Tracked by #1109
12rambau opened this issue Jan 23, 2023 · 10 comments
Closed
Tracked by #1109

logo is not display in the "latest" version of the doc #1130

12rambau opened this issue Jan 23, 2023 · 10 comments
Milestone

Comments

@12rambau
Copy link
Collaborator

I think we were too fast reviewing #1097.
logo_url seems to be relativ to the _static folder so the name set-up in the docs is leading to _static/_static/logo.svg that of course does not exist.

demo: https://pydata-sphinx-theme.readthedocs.io/en/latest/

@rossbar
Copy link
Contributor

rossbar commented Jan 23, 2023

We're seeing this in numpydoc's CI: https://github.com/numpy/numpydoc/actions/runs/3859437463/jobs/6689897153

@12rambau
Copy link
Collaborator Author

@rossbar this one is related to #1097 it should be solved with 0.13

@rossbar
Copy link
Contributor

rossbar commented Jan 23, 2023

FWIW I see this with pydata-sphinx-theme==0.11 as well on Sphinx 6.1. I think the bad interaction is with Sphinx 6. v0.12 of the theme works fine for me locally on Sphinx 5.3

@12rambau
Copy link
Collaborator Author

yes that's exactly what it is, they deprecated a jinja internal variable (logo) in favor of (logo_url)

@choldgraf
Copy link
Collaborator

I added this to the milestone for the next release because I suspect we will need to do some special casing for sphinx versions to prevent this from breaking for others.

@12rambau
Copy link
Collaborator Author

I'll check favicon as well, I suspect it will need some special casing as well

@12rambau
Copy link
Collaborator Author

12rambau commented Jan 26, 2023

from sphinx documentation:

html_logo
If given, this must be the name of an image file (path relative to the configuration directory) that is the logo of the docs, or URL that points an image file for the logo.

html_favicon
If given, this must be the name of an image file (path relative to the configuration directory) that is the favicon of the docs, or URL that points an image file for the favicon.

So it should work with these 2 configurations whatever the sphinx version:

html_logo = "_static/logo.svg"
html_favicon = "_static/logo.svg"

or

html_logo = "https://raw.githubusercontent.com/pydata/pydata-sphinx-theme/main/docs/_static/logo.svg"
html_favicon = "https://raw.githubusercontent.com/pydata/pydata-sphinx-theme/main/docs/_static/logo.svg"

@choldgraf
Copy link
Collaborator

Ah ok cool - as long as it works then that sounds great 🙂

1 similar comment
@choldgraf
Copy link
Collaborator

Ah ok cool - as long as it works then that sounds great 🙂

@choldgraf choldgraf mentioned this issue Jan 26, 2023
8 tasks
@choldgraf
Copy link
Collaborator

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 a pull request may close this issue.

3 participants