diff --git a/README.md b/README.md index 6fde5c93..d3de9313 100644 --- a/README.md +++ b/README.md @@ -138,19 +138,6 @@ html_theme_options = { } ``` -## IBM Projects: how to use blue color scheme for Ecosystem theme - -By default, the `qiskit-ecosystem` theme uses purple as an accent color. Most projects should continue to use this, but certain highly IBM-affiliated projects like Qiskit IBM Runtime can change the accent color to blue by setting up `conf.py` like this: - -```python -# Only intended for specific IBM projects. -html_theme_options = { - "light_css_variables": { - "color-brand-primary": "var(--qiskit-color-blue)", - } -} -``` - ## 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 bf9be6e1..ec452b7a 100644 --- a/example_docs/docs/conf.py +++ b/example_docs/docs/conf.py @@ -42,7 +42,6 @@ "sphinx.ext.autosummary", "sphinx.ext.mathjax", "sphinx.ext.viewcode", - "sphinx.ext.extlinks", "jupyter_sphinx", "sphinx_copybutton", "sphinx_design", @@ -64,16 +63,6 @@ _THEME = os.getenv("THEME", "qiskit") html_theme = _THEME -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. - html_theme_options = { - "light_css_variables": { - "color-brand-primary": "var(--qiskit-color-blue)", - } - } - html_context = { # Users of the theme can set prior version numbers. They'll # show up in the sidebar under the "Previous Versions" section. diff --git a/src/qiskit_sphinx_theme/assets/styles/_colors.scss b/src/qiskit_sphinx_theme/assets/styles/_colors.scss index fa321d31..9832b101 100644 --- a/src/qiskit_sphinx_theme/assets/styles/_colors.scss +++ b/src/qiskit_sphinx_theme/assets/styles/_colors.scss @@ -1,11 +1,9 @@ body { - // Define some Carbon color schemes from + // Define the Carbon color schemes from // https://github.com/carbon-design-system/carbon/blob/v10/packages/colors/src/colors.js - // that are consistent with Qiskit's branding. // - // While we set default colors, IBM-focused projects will want to use blue. + // Projects can override `--color-brand-primary` to whatever they want. --qiskit-color-purple: #6929C4; // purple70 - --qiskit-color-blue: #0043ce; // blue70 // Furo normally distinguishes between these two variables, but // we want them to be the same. diff --git a/tests/js/ecosystem.test.js b/tests/js/ecosystem.test.js index 34302be2..d6da30db 100644 --- a/tests/js/ecosystem.test.js +++ b/tests/js/ecosystem.test.js @@ -13,19 +13,8 @@ import { expect, test } from "@playwright/test"; -import { click } from "./utils"; - test("left side bar renders correctly", async ({ page }) => { await page.goto(""); const leftToC = page.locator(".sidebar-drawer"); await expect(leftToC).toHaveScreenshot(); }); - -test.describe("colors can be changed", () => { - test("translations", async ({ page }) => { - await page.goto(""); - await click(page, "div.qiskit-translations-container i"); - const translations = page.locator("div.qiskit-translations-container"); - await expect(translations).toHaveScreenshot(); - }); -}); diff --git a/tests/js/ecosystem.test.js-snapshots/colors-can-be-changed-translations-1-linux.png b/tests/js/ecosystem.test.js-snapshots/colors-can-be-changed-translations-1-linux.png deleted file mode 100644 index e8b2ad33..00000000 Binary files a/tests/js/ecosystem.test.js-snapshots/colors-can-be-changed-translations-1-linux.png and /dev/null differ diff --git a/tests/js/ecosystem.test.js-snapshots/left-side-bar-renders-correctly-1-linux.png b/tests/js/ecosystem.test.js-snapshots/left-side-bar-renders-correctly-1-linux.png index cb7143f8..49a6b331 100644 Binary files a/tests/js/ecosystem.test.js-snapshots/left-side-bar-renders-correctly-1-linux.png and b/tests/js/ecosystem.test.js-snapshots/left-side-bar-renders-correctly-1-linux.png differ