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

Use logo_url instead of "logo", removed in Sphinx 6 #133

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Qeole
Copy link

@Qeole Qeole commented Mar 29, 2023

In commit sphinx-doc/sphinx@ac0fc4b78173 (Remove more deprecated items in Sphinx 6.0 (#10562)), Sphinx removed the deprecated variables logo and favicon, in favour of logo_url and favicon_url, respectively. As a consequence, including the logo defined in html_logo no longer works when the sphinx_material theme is used with Sphinx >= 6.

Let's use logo_url if available in header.html. We also use it in sidebar.html, although this one doesn't matter much because CSS class md-nav__button gets a display:none in application.css.

In commit sphinx-doc/sphinx@ac0fc4b78173 ("Remove more deprecated items
in Sphinx 6.0 (#10562)"), Sphinx removed the deprecated variables "logo"
and "favicon", in favour of "logo_url" and "favicon_url", respectively.
As a consequence, including the logo defined in "html_logo" no longer
works when the sphinx_material theme is used with Sphinx >= 6.

Let's use logo_url if available in header.html. We also use it in
sidebar.html, although this one doesn't matter much because CSS class
md-nav__button gets a "display:none" in application.css.
@Qeole
Copy link
Author

Qeole commented Mar 29, 2023

As a side note (and not related to this PR), I'd be curious to understand how file sphinx_material/sphinx_material/logo-text.html is used. It does not seem to be included anywhere. It is referenced in examples for html_sidebars, but I can't find how it integrates into the resulting build. Even if I do include it from html_sidebars, I don't manage to find the resulting HTML in _build/. Is this expected?

@Qeole
Copy link
Author

Qeole commented Dec 11, 2023

Hi, is there anything I can do to help the PR move forward?

@holmboe
Copy link

holmboe commented Jan 11, 2024

We are also silently affected by this, glad that you found a solution @Qeole 👍

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 this pull request may close these issues.

None yet

2 participants