Wrong links generated for previous versions about qiskit_sphinx_theme HOT 2 CLOSED

This is only broken on Qiskit version 0.43 https://qiskit.org/documentation/stable/0.43/index.html. It works everywhere else, including https://qiskit.org/documentation/stable/0.44/index.html. To reproduce, you go to the stable version and then try clicking any other release in the Previous Releases left tab.

There are three builds to compare:

• 0.42 docs on March 21, Qiskit/qiskit-metapackage@4d5c2de. qiskit-sphinx-theme 1.10.2
• 0.43 docs on July 19, Qiskit/qiskit-metapackage@888fa5c. qiskit-sphinx-theme 1.13.1
• 0.44 docs Aug 17 in Qiskit Terra repo, Qiskit/qiskit@39b0cb8. qiskit-sphinx-theme 1.14.0

--

Between 0.43 and 0.44, the major difference is that 0.43 sets the option docs_url_prefix to documentation/stable/<version> whereas 0.44 always keeps it to documentation/:

https://github.com/Qiskit/qiskit-metapackage/blob/2b423d04dfb799650c1459b0e0d8a70dc1d095f3/tools/deploy_documentation_tag.sh#L36-L36

https://github.com/Qiskit/qiskit/blob/39b0cb82ab2f3bce5aee663ec1f1e0817aca71db/docs/conf.py#L34-L36

Jake was correct when he moved the docs config to always use documentation/. That is a bug to set it to include /stable, and it explains why the URL has /stable twice:

--

So, then the only remaining question is why did this work in 0.42 and prior versions? In 0.42 and earlier, the option was called content_prefix:

https://github.com/Qiskit/qiskit-metapackage/blob/96f760475cb6ed9969c574dd6d79eec49165e930/tools/deploy_documentation_tag.sh#L36-L36

At that point, our previous versions logic ignored content_prefix and the code solely worked for Qiskit Terra:

We used content_prefix for translations only:

Note that we don't deploy translations to versions, though! So the config was always bogus. If you click the language drop down on https://qiskit.org/documentation/stable/0.42/locale/bn_BN/index.html, it 404s, even though we had those translations provided in 0.42.

#321 replaced content_prefix with docs_url_prefix to fix Ecosystem projects using Previous Releases, which previously did not work. The implementation was sound in #321, but it was not correct to keep setting content_prefix=documentation/stable/<version> and to rename that to docs_url_prefix.

from qiskit_sphinx_theme.

This is now fixed via a manual redeploy of the 0.43 docs with keeping docs_url_prefix only set to documentation/. https://qiskit.org/documentation/stable/0.43/tutorials.html

from qiskit_sphinx_theme.