canonical / sphinx-docs-starter-pack

A documentation starter-pack
https://canonical-starter-pack.readthedocs-hosted.com/
Other
15 stars 39 forks source link

ReadTheDocs Version Warning Banner is not displayed. #141

Closed dviererbe closed 11 months ago

dviererbe commented 11 months ago

Read the docs has the ability to display a version warning banner if the user did not selected the latest version. This banner does not get displayed.

I think the reason for that is that an HTML element with the main role or the main tag is needed to inject the warning banner, for example:

<main>
  <!-- The banner would be injected here -->
  ...
</main>
<div role="main">
  <!-- The banner would be injected here -->
  ...
</div>

This is not present in the html output.

See the documentation for more details https://docs.readthedocs.io/en/stable/versions.html#version-warning

dviererbe commented 11 months ago

Maybe I just had a misconfiguration. I renamed the branches and it seems to work now: Screenshot from 2023-11-20 18-53-52