Ctrl+K
⚠️The latest release refactored our HTML, so double-check your custom CSS rules!⚠️

Changelog

Changelog#

v1.1.0 – 2023-12-19#

(full changelog)

Enhancements made#

Bugs fixed#

  • FIX: don’t include _static in css_files #794 (@agoose77)

  • FIX: properly handle CSS objects in css_files #791 (@agoose77)

  • FIX: builds on Windows and docs errors #784 (@choldgraf)

  • FIX: Correctly disappear search button icon on wide screens #781 (@choldgraf)

  • FIX: set bd-docs-nav as a class attribute instead of an id to restore compat with pydata-sphinx-theme JS #754 (@ogrisel)

  • FIX: typos in navbar documentation #707 (@CalMacCQ)

Maintenance and upkeep improvements#

Documentation improvements#

Other merged PRs#

Contributors to this release#

(GitHub contributors page for this release)

@AakashGfude | @adam-grant-hendry | @agoose77 | @akhmerov | @Alex-JG3 | @avivajpeyi | @bradbell | @callezenwaka | @CalMacCQ | @choldgraf | @dependabot | @Eutropios | @flying-sheep | @gilbertbw | @Gouvernathor | @jackshiwl | @jayaddison | @Kladdy | @LecrisUT | @Maetveis | @ogrisel | @pre-commit-ci | @Sdaher21 | @stevepiercy | @welcome

v1.0.1 – 2023-03-31#

This is a minor release supporting pydata>=0.13.3, with a few import changes from pydata.

v1.0.0 – 2023-03-01#

This is a major release that brings in the latest PyData Sphinx Theme and a number of new features with it. It also overhauls and standardizes the HTML structure of the theme. Because of this large refactor, we are bumping the major version to 1.0. Note that this doesn’t imply any new long-term support or stability, we will continue to try not to make major breaking changes but will continue incrementing major versions if we must do so.

Enhancements made#

Bugs fixed#

Maintenance and upkeep improvements#

Documentation improvements#

Breaking changes to structure and API#

Tips for migration#

Long sidebar entries now wrap. If you’d like to un-do this and revert to old behavior (where they are cut off if too long), then use the following CSS rule in your custom Sphinx CSS:

.bd-sidebar-primary a {
  word-wrap: unset;
}

single_page is deprecated. If you’d like to restore the old behavior (hiding sidebars), then use the following configuration in your conf.py:

html_sidebars = {
    "**": []
}

Contributors to this release#

(GitHub contributors page for this release)

@12rambau (activity) | @AakashGfude (activity) | @akhmerov (activity) | @AllenDowney (activity) | @avivajpeyi (activity) | @bmorris3 (activity) | @choldgraf (activity) | @chrisjsewell (activity) | @consideRatio (activity) | @dependabot (activity) | @feanil (activity) | @fm75 (activity) | @ghutchis (activity) | @guillaume-haerinck (activity) | @haklc (activity) | @iasbusi (activity) | @ivirshup (activity) | @James11222 (activity) | @kloczek (activity) | @ksuess (activity) | @martinfleis (activity) | @mathbunnyru (activity) | @mcjulian1107 (activity) | @melund (activity) | @mmcky (activity) | @paugier (activity) | @PhilipVinc (activity) | @pradyunsg (activity) | @pre-commit-ci (activity) | @rkdarst (activity) | @rossbar (activity) | @scmmmh (activity) | @sieler (activity) | @SilverRainZ (activity) | @stevepiercy (activity) | @trallard (activity) | @whyjz (activity) | @yuvipanda (activity) | @ZedThree (activity)

v0.3.3 – 2022-07-17#

Fixes:#

Enhancements made:#

Docs:#

v0.3.2 – 2022-03-28#

Two patch releases fixed two bugs for figure content in the margin.

v0.3.0 - 2022-03-25#

This is a significant change in the HTML and CSS of the site, with the goal of making it more standardized and robust. There are several design tweaks that have been made. Here is a short overview:

  • The sidebars are now a slightly smaller font, with more padding, to give more attention to the page’s content.

  • The HTML structure of the site has been re-worked to make sticky and other CSS behaviors more dependable.

  • The header buttons are now standardized and have an updated look and feel.

  • The in-page margin CSS is now more reliable

  • Improvements to scrollbar style throughout the site

See the PRs below for where most of these changes occurred.

(full changelog)

Enhancements made#

‼️ Breaking changes#

This release modifies the HTML structure of some of the major theme sections (in particular, the sidebar and top-bar). If you had custom CSS or JavaScript that assumed a particular HTML structure, double-check that it still behaves the same way, as you may need to adjust things for the new structure.

v0.1.10…v0.2.0#

This release includes a few under-the-hood and performance improvements to the CSS and HTML of the theme. While there are no major new features, some of these changes have restructured the HTML so double-check your documentation, especially if you had custom CSS rules the sidebar.

Here are a few improvements:

  • The right Table of Contents is now hidden using the Intersection Observer API which will reduce the number of JavaScript calls and improve reliability of this feature. #448 (@choldgraf)

  • The left sidebar is now toggle-able only with CSS, which should make it less prone to failure due to other conflicting javascript on the page. It now includes a “sidebar drawer” on mobile that gives more vertical space for the sidebar. #454 (@choldgraf)

  • You can now add Deepnote buttons for notebook launch buttons #385 (@jakubzitny)

v0.1.9 .. v0.1.10#

Maintenance release, to remove the unused click dependency.

v0.1.8 .. v0.1.9#

This is a minor release to fix a bug that was introduced which broke the right sidebar anchor links.

v0.1.7 .. v0.1.8#

(full changelog)

This is a minor release that makes a few bugfixes and small enhancements.

  • Printing to PDF from HTML is now formatted more elegantly #438 (@AakashGfude)

  • Minor stylistic bugfixes across the theme CSS

v0.1.6 .. v0.1.7#

Full Changelog: https://github.com/executablebooks/sphinx-book-theme/compare/v0.1.6…v0.1.7

Summary#

This release primarily updates the pydata theme to bring in a few new theme features and bug-fixes.

What’s Changed#

  • UPDATE: pydata sphinx theme v0.7.2 by @ocefpaf in https://github.com/executablebooks/sphinx-book-theme/pull/406

  • UPDATE: pydata-sphinx-theme 0.7.2 by @kousu in https://github.com/executablebooks/sphinx-book-theme/pull/429

  • IMPROVE: translation in the footer for Japanese language by @KengoTODA in https://github.com/executablebooks/sphinx-book-theme/pull/426

v0.1.5…v0.1.6#

(full changelog)

Enhancements made#

v0.1.5 - 2021-09-23#

(full changelog)

Enhancements made#

  • Move CSS hash to GET parameter so downstream themes can bust CSS properly #397 (@jacobtomlinson)

v0.1.4 - 2021-09-16#

(full changelog)

Enhancements made#

v0.1.3 - 2021-08-25#

(full changelog)

Enhancements made#

Bugs fixed#

v0.1.1…v0.1.2 - 2021-08-06#

(full changelog)

  • 🔧 MAINT: Reduce full-width from 136% to 134% #357: This avoid clipping full-width content on certain resolutions

  • 🐛 FIX: Dropdown menus on mobile #367: Menus are translated left, so that they are not clipped on small screens

v0.1.0…v0.1.1#

(full changelog)

New features added#

Enhancements made#

Bugs fixed#

  • 🐛 FIX: Path to custom output directory for _sources #346 (@dfm)

  • 🐛 FIX: Fixing sidebar animation #333 (@choldgraf)

v0.0.42…v0.1.0#

(full changelog)

This updates to the latest PyData Sphinx Theme, which re-works some of the HTML structure (thus, the minor version bump). It also includes some minor fixes to the scrolling and TOC behavior.

Enhancements made#

Bugs fixed#

API and Breaking Changes#

Deprecated features#

v0.0.42 2021-03-13#

(full changelog)

Bugs fixed#

  • 🐛 FIX: hover target bug on right TOC #300 (@DrDrij)

v0.0.41 2021-03-09#

(full changelog)

Enhancements made#

  • The Table of Contents titles is now configurable. See #299 (@AakashGfude)

  • The left sidebar has a drawer-style layout on mobile. See #298 (@DrDrij)

v0.0.40 - 2021-02-27#

(full changelog)

New features added#

Enhancements made#

Bugs fixed#

v0.0.39 - 2020-11-08#

(full changelog)

New features added#

  • sphinx sidebars functionality #233 (@choldgraf). You can now use the html_sidebars functionality that is native in Sphinx. See the sidebars documentation.

  • Collapsible lists in sidebars #226 (@AakashGfude). Sidebars that have nested sections will now have an arrow that allows you to reveal these sections without changing the current page. You can control the depth of expanded sections with show_navbar_depth.

Enhancements made#

v0.0.38#

Enhancements made#

👌 IMPROVE: Add missing aria-label to fullscreen button #228 (@foster999)

👌 IMPROVE: declare parallel read safe #225 (@rscohn2)

🐛 FIX: fixing dirhtml builds #230 (@choldgraf)

🐛 FIX: fixing margin for code blocks #229 (@choldgraf)

v0.0.37#

✨ NEW: Sphinx translations for all buttons and tooltips in major UI elements. See the Sphinx i18n documentation for how to activate other languages. #214 (@chrisjsewell)

⬆️ UPGRADE: pydata-sphinx-theme v0.4.0. See the pydata-sphinx-theme changelog for more information.

⬆️ UPGRADE: Use pyScss instead of libsass for scss compilation. This should make the theme more lightweight to install and develop locally. #200 (@hason)

Contributors to this release#

(GitHub contributors page for this release)

@choldgraf | @chrisjsewell | @fm75 | @hason | @najuzilu | @nathancarter | @pauleveritt | @pradyunsg |

v0.0.36 2020-08-25#

👌 IMPROVED: The main theme change in this release, is the addition of CSS styling for definition lists, including those created by sphinx.ext.autodoc. See Definition and Field Lists, and the Python API documentation.

🔧 MAINTENANCE: Under the hood, there has also been work undertaken to improve the development environment for working with the package. Thanks to @pradyunsg.

Contributors to this release#

@chrisjsewell | @pradyunsg

v0.0.34…v0.0.35#

(full changelog)

Enhancements 👌#

Bugs fixed 🐛#

Documentation improvements 📚#

Contributors to this release#

(GitHub contributors page for this release)

@AakashGfude | @choldgraf | @chrisjsewell | @pradyunsg | @welcome

Contents