Skip to content

Version not shown anymore for self-hosted documentations #1624

@GergelyKalmar

Description

@GergelyKalmar

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

Activity

humitos

humitos commented on Oct 30, 2024

@humitos
Member

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?

agjohnson

agjohnson commented on Oct 30, 2024

@agjohnson
Collaborator

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

added
AcceptedAccepted issue on our roadmap
and removed on Oct 31, 2024

11 remaining items

Loading
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    AcceptedAccepted issue on our roadmapBugA bug

    Type

    No type

    Projects

    Status

    Planned

    Milestone

    No milestone

    Relationships

    None yet

      Development

      Participants

      @humitos@sarnold@agjohnson@GergelyKalmar@StaticRocket

      Issue actions

        Version not shown anymore for self-hosted documentations · Issue #1624 · readthedocs/sphinx_rtd_theme