sphinx_rtd_theme icon indicating copy to clipboard operation
sphinx_rtd_theme copied to clipboard

Version not shown anymore for self-hosted documentations

Open GergelyKalmar opened this issue 1 year ago • 6 comments
trafficstars

Problem

We have a bunch of self-hosted documentation sites using the RTD theme. The version number used to be displaying fine below the project title (see e.g. https://docs.logikal.io/mindlab/latest/), however, this is not the case anymore with RTD theme v3. I understand that the version number has been replaced with the version selector, however, the version selector only works for sites hosted on readthedocs, effectively removing this information for self-hosted docs sites. There seems to be no way to switch back to the previous behavior.

Expected Results

We would like to have a config option to still show the version number instead of the version selector. Alternatively, the version selector should fall back to just displaying the current version when the Read the Docs Addon is not present.

If there's any workaround that we can apply in the meantime to get the version number back, that would be awesome.

Environment Info

  • Python Version: 3.12
  • Sphinx Version: 8.1.3
  • RTD Theme Version: 3.0.1

GergelyKalmar avatar Oct 28 '24 17:10 GergelyKalmar

I'm thinking that we may need to recover display_version and make it available only when READTHEDOCS == False. @agjohnson what are your thoughts here?

humitos avatar Oct 30 '24 11:10 humitos

That seems reasonable, I would bring back what we had here previously and make sure it matches the previous styling/etc.

agjohnson avatar Oct 30 '24 18:10 agjohnson

Is there progress on this?

sarnold avatar Mar 31 '25 05:03 sarnold

Unfortunately, no. We haven't had the time to jump into this. We would appreciate a PR here.

humitos avatar Apr 03 '25 15:04 humitos

@humitos I took a stab at it in #1648 . Please let me know if there is any feedback.

StaticRocket avatar May 31 '25 03:05 StaticRocket

@humitos friendly reminder that the PR is still waiting for review.

StaticRocket avatar Jun 11 '25 22:06 StaticRocket