executablebooks / sphinx-book-theme

A clean book theme for scientific explanations and documentation with Sphinx
https://sphinx-book-theme.readthedocs.io
BSD 3-Clause "New" or "Revised" License
409 stars 196 forks source link

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

Open 72757373656c6c opened 3 months ago

72757373656c6c commented 3 months ago

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

welcome[bot] commented 3 months ago

Thanks for opening your first issue here! Engagement like this is essential for open source projects! :hugs:
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! :tada: