Fix language toggle for docs (#504) (#509)

* Fix language toggle for docs * Fix copyright --------- Co-authored-by: Takashi Imamichi <[email protected]> (cherry picked from commit 3349304) Co-authored-by: Eric Arellano <[email protected]>
qiskit-community · May 10, 2023 · dfdfa66 · dfdfa66
1 parent 2df28e0
commit dfdfa66
Show file tree

Hide file tree

Showing 6 changed files with 10 additions and 42 deletions.
diff --git a/docs/_templates/page.html b/docs/_templates/page.html
diff --git a/docs/_templates/versions.html b/docs/_templates/versions.html
diff --git a/docs/conf.py b/docs/conf.py
@@ -106,6 +106,7 @@
     "sphinx.ext.doctest",
     "nbsphinx",
     "sphinx.ext.intersphinx",
+    "qiskit_sphinx_theme",
 ]
 html_static_path = ["_static"]
 templates_path = ["_templates"]

diff --git a/docs/versionutils.py b/docs/versionutils.py
@@ -1,6 +1,6 @@
 # This code is part of Qiskit.
 #
-# (C) Copyright IBM 2022.
+# (C) Copyright IBM 2022, 2023.
 #
 # This code is licensed under the Apache License, Version 2.0. You may
 # obtain a copy of this license in the LICENSE.txt file in the root directory
@@ -46,7 +46,7 @@ def _extend_html_context(app, config):
     context["translations_list"] = translations_list
     context["current_translation"] = _get_current_translation(config) or config.language
     context["translation_url"] = partial(_get_translation_url, config)
-    context["version_label"] = _get_version_label(config)
+    context["language_label"] = _get_language_label(config)
 
 
 def _get_current_translation(config):
@@ -63,7 +63,7 @@ def _get_translation_url(config, code, pagename):
     return _get_url(config, base, pagename)
 
 
-def _get_version_label(config):
+def _get_language_label(config):
     return "%s" % (_get_current_translation(config) or config.language,)
 
 

diff --git a/requirements-dev.txt b/requirements-dev.txt
@@ -16,4 +16,4 @@ qiskit-aer>=0.11
 mypy>=0.981
 mypy-extensions>=0.4.3
 nbsphinx
-qiskit_sphinx_theme>=1.10.*
+qiskit_sphinx_theme~=1.11.1
diff --git a/tox.ini b/tox.ini
@@ -48,8 +48,13 @@ commands =
   coverage3 report
 
 [testenv:docs]
+# Editable mode breaks macOS: https://github.com/sphinx-doc/sphinx/issues/10943
+usedevelop = False
 envdir = .tox/docs
 basepython = python3
+deps =
+  -r{toxinidir}/requirements-dev.txt
+  .
 commands =
   sphinx-build -W -T --keep-going -b html {posargs} docs/ docs/_build/html