html_title version not changed

[samtygier-stfc]

The classic template puts {{ shorttitle|e }} in the top nav bar and the page title. If not explicitly set it gets its value from html_title which defaults to '<project> <revision> documentation'.

When building with sphinx-multiversion, the oldest tag version is being used in html_title for all versions. So everything gets foo bar 0.9.0 documentation, even the newer versions.

[samtygier-stfc]

This looks tricky to fix as these variable get set to the defaults when the config is read. To change them later would need checking if they were set to a default or by the user.

Instead I worked around by adding a template layout.html

{%- extends "!layout.html" %}
    {%- block htmltitle %}
    {% if versions %}
    <title>{{ title|striptags|e }} - {{ project }} {{ current_version.name }} Documentation</title>
    {% else %}
     <title>{{ title|striptags|e }}{{ titlesuffix }}</title>
    {% endif %}
    {%- endblock %}

 {%- block rootrellink %}
 {% if versions %}
 <li class="nav-item nav-item-0"><a href="{{ pathto(master_doc)|e }}">{{ project }} {{ current_version.name }} Documentation</a>{{ reldelim1 }}</li>
 {% else %}
 <li class="nav-item nav-item-0"><a href="{{ pathto(master_doc)|e }}">{{ shorttitle|e }}</a>{{ reldelim1 }}</li>
 {% endif %}
{%- endblock %}

[Rjvs]

I worked around this problem by just setting html_title = "projectname" in conf.py although obviously this has the downside of removing version information from the title entirely.

[HassanAbouelela]

I don't think the root cause described here is correct. Yes, it does default to <project> v<revision> documentation, but when building the docs for a certain version, the <revision> should have the correct value, not the latest value. The reason it has the latest (wrong) value is that multiversion explicitly sets the -c flag to your current, actual conf.py, not to the one that was checked out in the temp directory:

https://github.com/Holzhaus/sphinx-multiversion/blob/cdc9cb591a738e67a5aacc458f9c95e2b88a94c2/sphinx_multiversion/main.py#L325-L326

I don't know if this is intentional or not, but it seems a bit strange that you would use the latest config and not the one that existed at the time of the version being built (it leads to issues like the one described here, and others such as not being able to change your extensions without breaking previous releases). There are certain benefits to being able to affect your build process retroactively, but those tasks are perhaps better served by other solutions such as pre/post hooks I've seen described around.