Skip to content

Releases: Qiskit/qiskit_sphinx_theme

Qiskit Sphinx Theme 1.15.0

14 Aug 22:57
0c5935c
Compare
Choose a tag to compare

The main change is adding the ability to have custom announcement banners at the top of the page for the qiskit theme (but not qiskit-ecosystem). See https://github.com/Qiskit/qiskit_sphinx_theme/tree/1.15#add-an-announcement-banner-to-all-pagesfor instructions.

1.14.0

25 Jul 18:11
2bd2cef
Compare
Choose a tag to compare

The 1.14 release series adds the qiskit-ecosystem theme, described in https://github.com/Qiskit/qiskit_sphinx_theme/releases/tag/1.14.0rc1.

Changes since 1.14.0rc1:

  • Add more descriptive alt text to "Qiskit Ecosystem" logo (Cherry-pick of #513) #517
  • Update Qiskit top nav bar to only have Terra docs (Cherry-pick of #522) #524

Qiskit Sphinx Theme 1.13.2

25 Jul 18:10
4a7d244
Compare
Choose a tag to compare
  • Update Qiskit top nav bar to only have Terra docs (Cherry-pick of #522) #523

Qiskit Sphinx Theme 1.14.0rc1

18 Jul 17:41
dd07623
Compare
Choose a tag to compare
Pre-release

This release adds the qiskit-ecosystem theme. It's meant to distinguish between Qiskit Terra vs the Ecosystem. The main changes are:

  1. Gets rid of the top Qiskit nav bar.
  2. Adds the project name and Qiskit Ecosystem logo to the left sidebar. (You can disable the logo or replace it with your own)
  3. IBM-specific projects like IBM Runtime can use a blue color scheme.

See https://github.com/Qiskit/qiskit_sphinx_theme for instructions.

Full Changelog: 1.13.0rc1...1.14.0rc1

Qiskit Sphinx Theme 1.13.1

17 Jul 16:14
228a587
Compare
Choose a tag to compare
  • Fix Pytorch theme not activating jQuery (Cherry-pick of #497) #503
  • Fix Furo's styling of inline page table of contents (Cherry-pick of #498) #499

Full Changelog: 1.13.0...1.13.1

Qiskit Sphinx Theme 1.13.0

11 Jul 19:20
5e19e5c
Compare
Choose a tag to compare

See the release notes from https://github.com/Qiskit/qiskit_sphinx_theme/releases/tag/1.13.0rc1 for what has changed in this release, including the new qiskit theme.

Since the 1.13.0rc2 release, this has the following changes:

  • Allow hiding Qiskit top nav bar in Furo (Cherry-pick of #468) #472
  • Fix Furo styling for API pages with methods on class page (Cherry-pick of #458) #478
  • Add copyright headers along with Furo license (Cherry-pick of #464) #467

Qiskit Sphinx Theme 1.13.0rc2

05 Jul 15:44
7dc0e2c
Compare
Choose a tag to compare
Pre-release

New features

  • Add back Furo's highlighting of page ToC (Cherry-pick of #455) #457

Bug fixes

  • Fix disabling Furo dark mode on Safari (Cherry-pick of #446) #452
  • Fix Furo wrapping of paragraphs and links (Cherry-pick of #448) #453
  • Fix Furo page layout on medium-sized screens (Cherry-pick of #450) #454
  • Fix Furo's responsiveness for qiskit-card and qiskit-call-to-action-item (Cherry-pick of #447)#461

Full Changelog: 1.13.0rc1...1.13.0rc2

Qiskit Sphinx Theme 1.13.0rc1

30 Jun 17:32
7c50849
Compare
Choose a tag to compare
Pre-release

The 1.13 release brings the new qiskit theme, built on top of Furo. The design aligns us with Carbon design requirements, has a more useful left side bar, and we went from 12,500 lines of CSS to 700 lines.

See https://github.com/Qiskit/qiskit_sphinx_theme#migrate-from-old-pytorch-theme-to-new-theme for migration instructions to the new theme. qiskit-sphinx-theme 2.0 will remove support for the old Pytorch theme, which we plan to release in July or August 2023.

We also made substantial infrastructure improvements, including adding visual regression testing. This will allow us to better maintain the quality of the theme and add future improvements.

API Changes

  • Add Furo to install_requires and bump Sphinx requirement to 6.0+ #339
  • Add qiskit-call-to-action-grid directive #431
  • Replace qiskit-card-item directive with simpler qiskit-card directive #415
  • Remove deprecated get_html_theme_path #352

New features

  • Add qiskit theme based on Furo #425
  • Update Qiskit top nav bar with new order and ecosystem links (#389) (#375)
  • Fix 404 errors for Thebe files #354

Bug fixes

  • Update Qiskit logo #409
  • Improve accessibility of qiskit-card being clickable #432

New Contributors

Full Changelog: 1.12.0...1.13.0rc1

Qiskit Sphinx Theme 1.12.1

16 Jun 14:14
1f31657
Compare
Choose a tag to compare

This release updates the Qiskit top nav bar with several tweaks: #390

Qiskit Sphinx Theme 1.12.0

22 May 19:29
39a3ee6
Compare
Choose a tag to compare

The 1.12 release is focused on stability. In addition to the improvements listed in https://github.com/Qiskit/qiskit_sphinx_theme/releases/tag/1.12.0rc1, we improved our internal infrastructure to facilitate future improvements.

This release only has one bug fix compared to 1.12.0rc1:

  • Fix regression of code links being blue (Cherry-pick of #336) (#337)