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

Version not shown anymore for self-hosted documentations #1624

Open
GergelyKalmar opened this issue Oct 28, 2024 · 2 comments
Open

Version not shown anymore for self-hosted documentations #1624

GergelyKalmar opened this issue Oct 28, 2024 · 2 comments
Labels
Accepted Accepted issue on our roadmap Bug A bug

Comments

@GergelyKalmar
Copy link

GergelyKalmar commented Oct 28, 2024

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
@humitos
Copy link
Member

humitos commented Oct 30, 2024

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
Copy link
Collaborator

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

@github-project-automation github-project-automation bot moved this to Planned in 📍Roadmap Oct 31, 2024
@humitos humitos added Accepted Accepted issue on our roadmap and removed Needed: replication Bug replication is required labels Oct 31, 2024
StaticRocket added a commit to StaticRocket/processor-sdk-doc that referenced this issue Dec 13, 2024
Add a workaround in the form of a css and template override for the
upstream sphinx_rtd_theme bug that removed the version section from self
hosted documentation.

readthedocs/sphinx_rtd_theme#1624

Signed-off-by: Randolph Sapp <[email protected]>
StaticRocket added a commit to StaticRocket/processor-sdk-doc that referenced this issue Dec 14, 2024
Add a workaround in the form of a css and template override for the
upstream sphinx_rtd_theme bug that removed the version section from self
hosted documentation.

readthedocs/sphinx_rtd_theme#1624

Signed-off-by: Randolph Sapp <[email protected]>
cshilwant pushed a commit to TexasInstruments/processor-sdk-doc that referenced this issue Dec 16, 2024
Add a workaround in the form of a css and template override for the
upstream sphinx_rtd_theme bug that removed the version section from self
hosted documentation.

readthedocs/sphinx_rtd_theme#1624

Signed-off-by: Randolph Sapp <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Accepted Accepted issue on our roadmap Bug A bug
Projects
Status: Planned
Development

No branches or pull requests

3 participants