[on hold] Add infrastructure for qiskit_legacy and qiskit_ecosystem_legacy themes

.github/workflows/main.yml

@@ -23,12 +23,17 @@ jobs:
         run: |
           python -m pip install -U 'tox<4'
       - name: Build Docs
-        run: tox -e py
+        run: |
+          # Make sure that all themes can build.
+          BUILD_DIR=docs/_build_ecosystem_legacy/html tox -e py -- -D html_theme=qiskit_ecosystem_legacy
+          BUILD_DIR=docs/_build_terra_legacy/html tox -e py -- -D html_theme=qiskit_legacy
       - name: Compress Artifacts
         run: |
           mkdir artifacts
-          tar -zcvf html_docs.tar.gz docs/_build/html
-          mv html_docs.tar.gz artifacts/.
+          tar -zcvf ecosystem_legacy_html_docs.tar.gz docs/_build_ecosystem_legacy/html
+          tar -zcvf terra_legacy_html_docs.tar.gz docs/_build_terra_legacy/html
+          mv ecosystem_legacy_html_docs.tar.gz artifacts/.
+          mv terra_legacy_html_docs.tar.gz artifacts/.
       - uses: actions/upload-artifact@v2
         with:
           name: html_docs

MANIFEST.in

@@ -1,3 +1,5 @@
 recursive-include qiskit_sphinx_theme *.html
 recursive-include qiskit_sphinx_theme theme.conf
-graft qiskit_sphinx_theme/pytorch_base/static
+graft qiskit_sphinx_theme/pytorch/base/static
+graft qiskit_sphinx_theme/pytorch/ecosystem/static
+graft qiskit_sphinx_theme/pytorch/terra/static

docs/conf.py

@@ -42,8 +42,7 @@
 
 release = qiskit_sphinx_theme.__version__
 
-html_theme = 'qiskit_sphinx_theme'  # use the theme in subdir 'theme'
-templates_path = ['_templates']
+html_theme = 'qiskit_ecosystem_legacy'
 
 rst_prolog = """
 .. |version| replace:: {0}

qiskit_sphinx_theme/__init__.py

@@ -27,10 +27,20 @@ def get_html_theme_path():
         stacklevel=2,
         category=DeprecationWarning,
     )
-    return _get_theme_absolute_path("pytorch_base")
+    return _get_theme_absolute_path("pytorch/ecosystem")
 
 
 # See https://www.sphinx-doc.org/en/master/development/theming.html
 def setup(app):
-    app.add_html_theme("qiskit_sphinx_theme", _get_theme_absolute_path("pytorch_base"))
+    # Note: base themes should not be exposed in the entry_points for the package
+    # (in setup.py/pyproject.toml). We only need to register the theme for `inherit` in `theme.conf`
+    # to work.
+    app.add_html_theme("__qiskit_pytorch_base", _get_theme_absolute_path("pytorch/base"))
+
+    app.add_html_theme('qiskit_legacy', _get_theme_absolute_path("pytorch/terra"))
+
+    ecosystem_pytorch_theme = _get_theme_absolute_path("pytorch/ecosystem")
+    app.add_html_theme('qiskit_sphinx_theme', ecosystem_pytorch_theme)
+    app.add_html_theme("qiskit_ecosystem_legacy", ecosystem_pytorch_theme)
+
     return {'parallel_read_safe': True, 'parallel_write_safe': True}

qiskit_sphinx_theme/pytorch/ecosystem/theme.conf

@@ -0,0 +1,3 @@
+[theme]
+inherit = __qiskit_pytorch_base
+stylesheet = css/theme.css, css/overrides.css

qiskit_sphinx_theme/pytorch/terra/theme.conf

@@ -0,0 +1,3 @@
+[theme]
+inherit = __qiskit_pytorch_base
+stylesheet = css/theme.css, css/overrides.css

setup.py

@@ -12,6 +12,8 @@
     entry_points={
         'sphinx.html_themes': [
             'qiskit_sphinx_theme = qiskit_sphinx_theme',
+            'qiskit_ecosystem_legacy = qiskit_sphinx_theme',
+            'qiskit_legacy = qiskit_sphinx_theme',
         ],
     },
     license='Apache 2',

tox.ini

@@ -8,23 +8,23 @@ usedevelop = True
 install_command = pip install -U {opts} {packages}
 deps =
   -r{toxinidir}/requirements-dev.txt
-commands = sphinx-build -b html -W --keep-going -j auto {posargs} docs/ docs/_build/html
+commands = sphinx-build -b html -W --keep-going -j auto {posargs} docs/  {env:BUILD_DIR:docs/_build/html}
 
 [testenv:docs-guide]
 usedevelop = True
 install_command = pip install -U {opts} {packages}
 deps =
   -r{toxinidir}/requirements-dev.txt
   -r{toxinidir}/docs_guide/requirements-extra.txt
-commands = sphinx-build -b html -W --keep-going -j auto {posargs} docs_guide/ docs_guide/_build/html
+commands = sphinx-build -b html -W --keep-going -j auto {posargs} docs_guide/ {env:BUILD_DIR:docs_guide/_build/html}
 
 [testenv:doctest]
 usedevelop = True
 install_command = pip install -U {opts} {packages}
 deps =
   -r{toxinidir}/requirements-dev.txt
   -r{toxinidir}/docs_guide/requirements-extra.txt
-commands = sphinx-build -b doctest -W --keep-going -j auto {posargs} docs_guide/ docs_guide/_build/doctest
+commands = sphinx-build -b doctest -W --keep-going -j auto {posargs} docs_guide/ {env:BUILD_DIR:docs_guide/_build/doctest}
 
 [testenv:lint]
 envdir = .tox/lint