From 375f1bbb51d4f0ac534832e4f44f5d2d4ea59454 Mon Sep 17 00:00:00 2001
From: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
Date: Thu, 30 Nov 2023 13:26:07 -0500
Subject: [PATCH 1/5] Remove Pytorch
---
CONTRIBUTING.md | 14 +-
README.md | 49 +-
example_docs/docs/conf.py | 12 +-
pyproject.toml | 3 -
src/qiskit_sphinx_theme/__init__.py | 8 -
.../pytorch/breadcrumbs.html | 31 -
src/qiskit_sphinx_theme/pytorch/footer.html | 78 -
.../pytorch/languages.html | 40 -
src/qiskit_sphinx_theme/pytorch/layout.html | 206 -
src/qiskit_sphinx_theme/pytorch/search.html | 60 -
.../pytorch/searchbox.html | 21 -
src/qiskit_sphinx_theme/pytorch/sidebar.html | 115 -
.../pytorch/static/css/theme.css | 12700 ----------------
.../static/images/chevron-down-grey.svg | 18 -
.../static/images/chevron-right-purple.svg | 66 -
.../static/images/chevron-right-white.svg | 17 -
.../pytorch/static/images/icon-close.svg | 21 -
.../static/images/icon-menu-dots-dark.svg | 42 -
.../pytorch/static/images/launch.svg | 5 -
.../static/images/logo-facebook-dark.svg | 8 -
.../pytorch/static/images/logo-icon.svg | 12 -
.../static/images/logo-twitter-dark.svg | 16 -
.../static/images/logo-youtube-dark.svg | 21 -
.../pytorch/static/images/logo.png | Bin 31503 -> 0 bytes
.../pytorch/static/images/logo.svg | 1 -
.../pytorch/static/images/logo_wordmark.svg | 1 -
.../static/images/qiskit-chevron-down.svg | 4 -
.../static/images/qiskit-chevron-up.svg | 4 -
.../pytorch/static/images/search-icon.svg | 90 -
.../static/images/view-page-source-icon.svg | 70 -
.../pytorch/static/js/modernizr.min.js | 4 -
.../pytorch/static/js/theme.js | 962 --
.../static/js/web-components/top-nav-bar.js | 632 -
src/qiskit_sphinx_theme/pytorch/theme.conf | 30 -
tox.ini | 5 -
35 files changed, 9 insertions(+), 15357 deletions(-)
delete mode 100644 src/qiskit_sphinx_theme/pytorch/breadcrumbs.html
delete mode 100644 src/qiskit_sphinx_theme/pytorch/footer.html
delete mode 100644 src/qiskit_sphinx_theme/pytorch/languages.html
delete mode 100644 src/qiskit_sphinx_theme/pytorch/layout.html
delete mode 100644 src/qiskit_sphinx_theme/pytorch/search.html
delete mode 100644 src/qiskit_sphinx_theme/pytorch/searchbox.html
delete mode 100644 src/qiskit_sphinx_theme/pytorch/sidebar.html
delete mode 100644 src/qiskit_sphinx_theme/pytorch/static/css/theme.css
delete mode 100644 src/qiskit_sphinx_theme/pytorch/static/images/chevron-down-grey.svg
delete mode 100644 src/qiskit_sphinx_theme/pytorch/static/images/chevron-right-purple.svg
delete mode 100644 src/qiskit_sphinx_theme/pytorch/static/images/chevron-right-white.svg
delete mode 100644 src/qiskit_sphinx_theme/pytorch/static/images/icon-close.svg
delete mode 100644 src/qiskit_sphinx_theme/pytorch/static/images/icon-menu-dots-dark.svg
delete mode 100644 src/qiskit_sphinx_theme/pytorch/static/images/launch.svg
delete mode 100644 src/qiskit_sphinx_theme/pytorch/static/images/logo-facebook-dark.svg
delete mode 100644 src/qiskit_sphinx_theme/pytorch/static/images/logo-icon.svg
delete mode 100644 src/qiskit_sphinx_theme/pytorch/static/images/logo-twitter-dark.svg
delete mode 100644 src/qiskit_sphinx_theme/pytorch/static/images/logo-youtube-dark.svg
delete mode 100644 src/qiskit_sphinx_theme/pytorch/static/images/logo.png
delete mode 100644 src/qiskit_sphinx_theme/pytorch/static/images/logo.svg
delete mode 100644 src/qiskit_sphinx_theme/pytorch/static/images/logo_wordmark.svg
delete mode 100644 src/qiskit_sphinx_theme/pytorch/static/images/qiskit-chevron-down.svg
delete mode 100644 src/qiskit_sphinx_theme/pytorch/static/images/qiskit-chevron-up.svg
delete mode 100644 src/qiskit_sphinx_theme/pytorch/static/images/search-icon.svg
delete mode 100644 src/qiskit_sphinx_theme/pytorch/static/images/view-page-source-icon.svg
delete mode 100644 src/qiskit_sphinx_theme/pytorch/static/js/modernizr.min.js
delete mode 100644 src/qiskit_sphinx_theme/pytorch/static/js/theme.js
delete mode 100644 src/qiskit_sphinx_theme/pytorch/static/js/web-components/top-nav-bar.js
delete mode 100644 src/qiskit_sphinx_theme/pytorch/theme.conf
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index a344ecb7..6b7a75c6 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -19,7 +19,6 @@ There are a few important subfolders to be aware of:
This subfolder contains the HTML, CSS, and Python files that are used for the Qiskit themes. It has these folders:
* `assets`: CSS and JavaScript for the `qiskit` theme.
-* `pytorch`: all the code for the legacy Pytorch theme (`qiskit_sphinx_theme`).
* `ecosystem`: the code for the `qiskit-ecosystem` theme, which is built on top of the base `qiskit` theme. This folder only has overrides.
* `theme`: static files, like HTML templates, for the `qiskit` theme.
@@ -28,7 +27,7 @@ The top-level Python files are used for logic used by the theme, such as `transl
### `/example_docs`
This subfolder contains a scaled down version of the Sphinx build that builds the documentation for the Qiskit repos.
-It pulls styles from the `/src` subfolder. You can check any changes you are making to theme by building the documentation (see running locally section) and opening the HTML files generated in `example_docs/docs/_qiskit_build`, `example_docs/docs/_ecosystem_build`, and `example_docs/docs/_pytorch_build`.
+It pulls styles from the `/src` subfolder. You can check any changes you are making to theme by building the documentation (see running locally section) and opening the HTML files generated in `example_docs/docs/_qiskit_build` and `example_docs/docs/_ecosystem_build`.
### `/docs_guide`
This subfolder contains guidance on how to write documentation and build sphinx projects for Qiskit and Qiskit Ecosystem projects. You can view the fully rendered docs guide at https://qisk.it/docs-guide
@@ -45,9 +44,6 @@ We use [Tox](https://tox.wiki/en/latest/), which you will need to install global
* Build `example_docs/` with the `qiskit-ecosystem` theme:
1. `tox -e ecosystem`
2. Open up `example_docs/docs/_ecosystem_build/index.html` in your browser
-* Build `example_docs/` with the legacy Pytorch theme:
- 1. `tox -e pytorch`
- 2. Open up `example_docs/docs/_pytorch_build/index.html` in your browser
* Build `docs_guide`:
1. `tox -e docs-guide`
2. Open up `docs_guide/_build/html/index.html` in your browser.
@@ -115,15 +111,13 @@ We use web components from https://github.com/Qiskit/web-components to include c
To update the top nav bar web component:
1. In https://github.com/Qiskit/web-components, run `npm install` then `npm run build`.
-2. There should be a file created at the root of the web components repository called `experimental-bundled-ui-shell.js`. Copy its contents into these files in this theme repository:
- 1. `src/qiskit_sphinx_theme/pytorch/static/js/web-components/top-nav-bar.js`
- 2. `src/qiskit_sphinx_theme/theme/qiskit-sphinx-theme/static/js/web-components/top-nav-bar.js`
-3. Build the example docs with `tox -e qiskit` and `tox -e pytorch` to ensure everything works.
+2. There should be a file created at the root of the web components repository called `experimental-bundled-ui-shell.js`. Copy its contents into `src/qiskit_sphinx_theme/theme/qiskit-sphinx-theme/static/js/web-components/top-nav-bar.js`
+3. Build the example docs with `tox -e qiskit` to ensure everything works.
If you want to add a new web component:
1. Work with the web components repository's team to set up `npm run build` to generate a single JavaScript file.
-2. Add the file contents to the `src/qiskit_sphinx_theme/theme/qiskit-sphinx-theme/static/js/web-components/` folder in this theme repository. (We shouldn't add web components to Pytorch.)
+2. Add the file contents to the `src/qiskit_sphinx_theme/theme/qiskit-sphinx-theme/static/js/web-components/` folder in this theme repository.
3. Load the web component in `extra_head.html` with a line like ``.
4. Use the web component element in the relevant HTML, e.g. `` in `layout.html`. Remember to surround the change with a `QISKIT CHANGE:` comment.
5. Build the example docs with `tox -e qiskit` to ensure everything works.
diff --git a/README.md b/README.md
index b5fe63c0..e6da2e70 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,11 @@
# qiskit-sphinx-theme
-The Sphinx themes for Qiskit and Qiskit Ecosystem documentation.
+The Sphinx themes for Qiskit Ecosystem documentation.
### Warning: new theme migration
-In qiskit-sphinx-theme 1.13, we added the new `qiskit` theme, which migrates from Pytorch to Furo for several improvements. qiskit-sphinx-theme 1.14 added the `qiskit-ecosystem` theme. The old Pytorch theme will be removed in qiskit-sphinx-theme 2.0, which we expect to release in July or August 2023.
+In qiskit-sphinx-theme 1.14, we replaced the old `qiskit_sphinx_theme` based on Pytorch with the new `qiskit-ecosystem` theme based on Furo. The old theme was removed in qiskit-sphinx-theme 2.0.
-See the section [Migrate from old Pytorch theme to new theme](#migrate-from-old-pytorch-theme-to-new-theme) for migration instructions.
+See [Migrate from old Pytorch theme to new theme](https://github.com/Qiskit/qiskit_sphinx_theme/blob/1.16/README.md#migrate-from-old-pytorch-theme-to-new-theme) for migration instructions.
## Overview
@@ -205,49 +205,6 @@ html_theme_options = {
}
```
-## Migrate from old Pytorch theme to new theme
-
-In qiskit-sphinx-theme 1.13, we migrated to a new Sphinx theme called `qiskit`, which is based on Furo from the pip, Black, and attrs documentation. See https://github.com/Qiskit/qiskit_sphinx_theme/issues/232 for the motivation. qiskit-sphinx-theme 1.14 added the `qiskit-ecosystem` theme for Ecosystem projects.
-
-qiskit-sphinx-theme 1.13+ continues to support the legacy Pytorch theme, but support will be removed in version 2.0.
-
-To migrate, in `conf.py`:
-
-1. Ensure that `"qiskit_sphinx_theme"` is in the `extensions` list.
-2. Set `html_theme = "qiskit-ecosystem"` rather than `"qiskit_sphinx_theme"`. (`qiskit` should only be used by Qiskit Terra.)
-3. Remove all `html_theme_options`.
-4. Remove `expandable_sidebar` from `html_context`, if set. If it was set, follow the below section [How to migrate expandable_sidebar](#how-to-migrate-expandable_sidebar).
-
-Render the docs and check that everything looks how expected. If not, please open a GitHub issue or reach out on Slack for help.
-
-### How to migrate expandable_sidebar
-
-With the old theme, to have expandable folders, you had to have a dedicated `.. toctree ::` directive with a `:caption:` option, like this:
-
-```rst
-.. toctree::
- :caption: My Folder
- :hidden:
-
- Page 1
- Page 2
-```
-
-Instead, the new theme will render the `:caption:` as a top-level section header in the left sidebar, with top-level entries for each page. See the screenshot in the PR description of https://github.com/Qiskit/qiskit_sphinx_theme/pull/384 for an example of how the old theme renders `:caption:` and compare to [the new theme](tests/js/qiskit.test.js-snapshots/left-side-bar-renders-correctly-1-linux.png).
-
-Additionally, the new theme renders pages with their own subpages as expandable folders, unlike the old theme. [For example](tests/js/qiskit.test.js-snapshots/left-side-bar-renders-correctly-1-linux.png), `` will include all subpages that are listed in the `.. toctree ::` of the page `apidocs/index.rst`.
-
-So, when migrating, you have to decide which behavior you want:
-
-- Use the new theme's style. No changes necessary.
-- Use the new theme's style, but get rid of the top level section header. To implement:
- 1. Consolidate the `.. toctree ::` directive with earlier ones so that they are all in the same `toctree`.
-- Keep the `:caption:` as an expandable folder, rather than a top-level section header. To implement:
- 1. Create a new directory and RST file like `my_folder/index.rst`.
- 2. Move the `.. toctree::` directive to that page.
- 3. Get rid of the `:caption:` option.
- 4. Link to the new file `my_folder/index.rst` in the parent `index.rst` by adding it to a `.. toctree ::` in the parent.
-
## Tip: suggested site structure
To keep UX/UI similar across different Qiskit packages, we encourage the following structure for you sidebar, which can be set in the toctree of your `index.rst`:
diff --git a/example_docs/docs/conf.py b/example_docs/docs/conf.py
index e9d59c95..91f6b104 100644
--- a/example_docs/docs/conf.py
+++ b/example_docs/docs/conf.py
@@ -59,20 +59,12 @@
# for interpolation, i.e. Sphinx doesn't have built-in interpolation.
html_title = f"{project} {release}"
-# This allows us to test both the Furo and Pytorch themes. In normal repositories, `html_theme`
+# This allows us to test both the Qiskit and Qiskit Ecosystem themes. In normal repositories, `html_theme`
# would be set to one specific theme.
_THEME = os.getenv("THEME", "qiskit")
html_theme = _THEME
-if _THEME == "qiskit_sphinx_theme":
- html_theme_options = {
- "logo_only": True,
- "display_version": True,
- "prev_next_buttons_location": "bottom",
- }
- # Sets a better style for code syntax highlighting.
- pygments_style = "colorful"
-elif _THEME == "qiskit-ecosystem":
+if _THEME == "qiskit-ecosystem":
# This tests out that ecosystem projects can change the color scheme.
# Only specific IBM projects should set this! Most Ecosystem projects
# should use the default of purple.
diff --git a/pyproject.toml b/pyproject.toml
index bc97b7c8..4b1a1fc9 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -27,15 +27,12 @@ dependencies = [
"docutils",
# Keep in sync with Furo's constraint.
"sphinx>=6.0",
- # Remove jQuery once we get rid of the Pytorch theme.
- "sphinxcontrib-jquery",
# See CONTRIBUTING.md for how to upgrade Furo.
"furo==2023.8.19",
]
[project.entry-points."sphinx.html_themes"]
qiskit = "qiskit_sphinx_theme"
-qiskit_sphinx_theme = "qiskit_sphinx_theme"
qiskit-ecosystem = "qiskit_sphinx_theme"
[project.urls]
diff --git a/src/qiskit_sphinx_theme/__init__.py b/src/qiskit_sphinx_theme/__init__.py
index 59ccc261..6c58742d 100644
--- a/src/qiskit_sphinx_theme/__init__.py
+++ b/src/qiskit_sphinx_theme/__init__.py
@@ -68,8 +68,6 @@ def remove_thebe_if_not_needed(
def activate_furo(app: sphinx.application.Sphinx, config: sphinx.config.Config) -> None:
- if config.html_theme == "qiskit_sphinx_theme":
- return
# We set a low priority so that our Qiskit CSS file overrides Furo.
app.add_css_file("styles/furo.css", 100)
app.add_js_file("scripts/qiskit-sphinx-theme.js")
@@ -92,11 +90,6 @@ def setup(app: sphinx.application.Sphinx) -> dict[str, bool]:
# Used to generate URL references. Expected to be e.g. `ecosystem/finance`.
app.add_config_value("docs_url_prefix", default=None, rebuild="html", types=[str])
- # Sphinx 6 stopped including jQuery by default. Our Pytorch theme depend on jQuery,
- # so activate it for our users automatically. Unfortunately, we can't make this activation
- # conditional based on which theme is chosen.
- app.setup_extension("sphinxcontrib.jquery")
-
# We always activate these plugins, but they are only used when users:
# * use the directives in their RST,
# * set `translations_list` in conf.py, or
@@ -105,7 +98,6 @@ def setup(app: sphinx.application.Sphinx) -> dict[str, bool]:
previous_releases.setup(app)
translations.setup(app)
- app.add_html_theme("qiskit_sphinx_theme", _get_theme_absolute_path("pytorch"))
app.add_html_theme("qiskit", _get_theme_absolute_path("theme/qiskit-sphinx-theme"))
app.add_html_theme("qiskit-ecosystem", _get_theme_absolute_path("ecosystem"))
diff --git a/src/qiskit_sphinx_theme/pytorch/breadcrumbs.html b/src/qiskit_sphinx_theme/pytorch/breadcrumbs.html
deleted file mode 100644
index 6bd4240a..00000000
--- a/src/qiskit_sphinx_theme/pytorch/breadcrumbs.html
+++ /dev/null
@@ -1,31 +0,0 @@
-{#-
- This code is a Qiskit project
-
- (C) Copyright IBM 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
- of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
-
- Any modifications or derivative works of this code must retain this
- copyright notice, and modified files need to carry a notice indicating
- that they have been altered from the originals.
--#}
-
-
diff --git a/src/qiskit_sphinx_theme/pytorch/footer.html b/src/qiskit_sphinx_theme/pytorch/footer.html
deleted file mode 100644
index a6516830..00000000
--- a/src/qiskit_sphinx_theme/pytorch/footer.html
+++ /dev/null
@@ -1,78 +0,0 @@
-{#-
- This code is a Qiskit project.
-
- (C) Copyright IBM 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
- of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
-
- Any modifications or derivative works of this code must retain this
- copyright notice, and modified files need to carry a notice indicating
- that they have been altered from the originals.
--#}
-
-
-
-
-
diff --git a/src/qiskit_sphinx_theme/pytorch/languages.html b/src/qiskit_sphinx_theme/pytorch/languages.html
deleted file mode 100644
index de893350..00000000
--- a/src/qiskit_sphinx_theme/pytorch/languages.html
+++ /dev/null
@@ -1,40 +0,0 @@
-{#-
- This code is a Qiskit project.
-
- (C) Copyright IBM 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
- of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
-
- Any modifications or derivative works of this code must retain this
- copyright notice, and modified files need to carry a notice indicating
- that they have been altered from the originals.
--#}
-
-{% if translations_list %}
-
-{% endif %}
diff --git a/src/qiskit_sphinx_theme/pytorch/layout.html b/src/qiskit_sphinx_theme/pytorch/layout.html
deleted file mode 100644
index 8aa0b33d..00000000
--- a/src/qiskit_sphinx_theme/pytorch/layout.html
+++ /dev/null
@@ -1,206 +0,0 @@
-{#-
- This code is a Qiskit project.
-
- (C) Copyright IBM 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
- of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
-
- Any modifications or derivative works of this code must retain this
- copyright notice, and modified files need to carry a notice indicating
- that they have been altered from the originals.
--#}
-
-{# Sphinx template variable setup #}
-{%- if not embedded and docstitle %}
- {%- set titlesuffix = " — "|safe + docstitle|e %}
-{%- else %}
- {%- set titlesuffix = "" %}
-{%- endif %}
-{%- set lang_attr = 'en' if language == None else (language | replace('_', '-')) -%}
-
-
-
-
-
-
- {{ metatags }}
- {%- block htmltitle %}
- {{ title|striptags|e }}{{ titlesuffix }}
- {%- endblock %}
- {%- if favicon_url %}
-
- {%- endif %}
-
- {#- CSS #}
- {%- for css in css_files %}
- {%- if css|attr("rel") %}
-
- {%- else %}
-
- {%- endif %}
- {%- endfor %}
- {%- for cssfile in extra_css_files %}
-
- {%- endfor -%}
-
-
-
-
- {%- if analytics_enabled %}
-
-
-
- {%- endif -%}
-
-
-
-
-
-
- {% block extrabody %} {% endblock %}
-
-
-
-
- {% include "languages.html" %}
-
-
-
-
-{%- block footer %} {% endblock %}
-
-
-
- {%- for scriptfile in script_files %}
- {{ js_tag(scriptfile) }}
- {%- endfor %}
-
-
-
-
-
-
-
-
-
-
-
diff --git a/src/qiskit_sphinx_theme/pytorch/search.html b/src/qiskit_sphinx_theme/pytorch/search.html
deleted file mode 100644
index 48dd39f0..00000000
--- a/src/qiskit_sphinx_theme/pytorch/search.html
+++ /dev/null
@@ -1,60 +0,0 @@
-{#-
- This code is a Qiskit project.
-
- (C) Copyright IBM 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
- of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
-
- Any modifications or derivative works of this code must retain this
- copyright notice, and modified files need to carry a notice indicating
- that they have been altered from the originals.
--#}
-
-{#
- basic/search.html
- ~~~~~~~~~~~~~~~~~
-
- Template for the search page.
-
- :copyright: Copyright 2007-2013 by the Sphinx team, see AUTHORS.
- :license: BSD, see LICENSE for details.
-#}
-{%- extends "layout.html" %}
-{% set title = _('Search') %}
-{% set script_files = script_files + ['_static/searchtools.js'] %}
-{% set script_files = script_files + ['_static/language_data.js'] %}
-{% block footer %}
-
- {{ super() }}
-{% endblock %}
-{% block body %}
-
-
- {% if search_performed %}
-
{{ _('Search Results') }}
- {% if not search_results %}
-
{{ _('Your search did not match any documents. Please make sure that all words are spelled correctly and that you\'ve selected enough categories.') }}
- {% endif %}
- {% endif %}
-
- {% if search_results %}
-
- {% for href, caption, context in search_results %}
-
-{% endblock %}
diff --git a/src/qiskit_sphinx_theme/pytorch/searchbox.html b/src/qiskit_sphinx_theme/pytorch/searchbox.html
deleted file mode 100644
index c3777951..00000000
--- a/src/qiskit_sphinx_theme/pytorch/searchbox.html
+++ /dev/null
@@ -1,21 +0,0 @@
-{#-
- This code is a Qiskit project.
-
- (C) Copyright IBM 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
- of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
-
- Any modifications or derivative works of this code must retain this
- copyright notice, and modified files need to carry a notice indicating
- that they have been altered from the originals.
--#}
-
-