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

sphinx-book-theme shows incorrect theme and theme_version #829

Open
72757373656c6c opened this issue Mar 28, 2024 · 1 comment
Open

sphinx-book-theme shows incorrect theme and theme_version #829

72757373656c6c opened this issue Mar 28, 2024 · 1 comment
Labels
bug Something isn't working

Comments

@72757373656c6c
Copy link

Describe the bug

Context

In conf.py, when footer_content_items is set to:

footer_content_items": ["copyright", "last-updated", "sphinx-version", "theme-version"]

Expectation

I expect the theme and theme-version to be "Sphinx Book Theme":

Built with the Sphinx Book Theme 1.1.2.

Bug

But instead the theme and theme-version are PyData:

Built with the PyData Sphinx Theme 0.15.2.

There were no console errors.

Problem

The sphinx-book-theme shows incorrect theme and theme_version. The correct theme and theme_version should be shown.

Reproduce the bug

  1. In conf.py set the theme: html_theme = "sphinx_book_theme"

  2. In conf.py add footer_content_items": ["copyright", "last-updated", "sphinx-version", "theme-version"] to html_theme_options.

  3. In a terminal type make clean ; O='-E -W --keep-going' make html

  4. View the html output in a browser, specifically the footer content.

A workaround is to do the following:

  1. In conf.py add "footer_content_items": ["copyright", "last-updated", "sphinx-version", "extra-footer"]

  2. Add "extra_footer": '<p class="theme-version">Built with the <a href="https://sphinx-book-theme.readthedocs.io/en/stable">Sphinx Book Theme</a> 1.1.2.</p>' to html_theme_options.

List your environment

Environment

  • Sphinx 7.2.6
  • sphinx-book-theme 1.1.2
  • pydata-sphinx-theme 0.15.2
  • myst-parser 2.0.0
  • python 3.11.6-1
@72757373656c6c 72757373656c6c added the bug Something isn't working label Mar 28, 2024
Copy link

welcome bot commented Mar 28, 2024

Thanks for opening your first issue here! Engagement like this is essential for open source projects! 🤗

If you haven't done so already, check out EBP's Code of Conduct. Also, please try to follow the issue template as it helps other community members to contribute more effectively.

If your issue is a feature request, others may react to it, to raise its prominence (see Feature Voting).

Welcome to the EBP community! 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant