Build one ref (e.g. current version) to the top-level

[The-Ludwig]

Problem Description

When building with sphinx-multiversion, each version is build into a subdirectory of the output flag.
I want to have one version (e.g. the current version / main branch) directly at the top level. This is currently not possible via the smv_outpudir format string.

Proposed Solution

My fork solved this by adding a new sphinx variable smv_toplevelref and if it is given,
then the outputdir of the ref with the same name will be manually set to an empty string.

I am happy to merge my fork and write additional documentation for the features, if this is wanted.

[Holzhaus]

I suppose this implicated a lot of edge cases. What if a branch output dir has the same name as an output dir from sphinx?

[Holzhaus]

Could you elaborate a bit on the use case? Wouldn't it be sufficient to drop an "index.html" into the top level dir that just redirects to the "index.html" in the main branch output dir?

[The-Ludwig]

I suppose this implicated a lot of edge cases. What if a branch output dir has the same name as an output dir from sphinx?

Then this will fail or produce undefined behavior. The fix is easy though: rename the folder. The easiest fix to get this functionality currently is to fork smv.
But I agree, this is one edge case which could need more polishing.

Could you elaborate a bit on the use case? Wouldn't it be sufficient to drop an "index.html" into the top level dir that just redirects to the "index.html" in the main branch output dir?

Yes I can! I do care about nice looking URLs and I know that some people keep the links to the webpage I am deploying. I do not want the old links to become invalid.