Changelog#
v1.1.2 -- 2024-02-13#
Enhancements made#
Bugs fixed#
Contributors to this release#
v1.1.1 -- 2024-02-13#
Enhancements made#
Bugs fixed#
Other merged PRs#
Build(deps): Bump actions/setup-python from 4 to 5 #803 (@dependabot)
[pre-commit.ci] pre-commit autoupdate #801 (@pre-commit-ci)
Contributors to this release#
(GitHub contributors page for this release)
@agoose77 | @choldgraf | @dependabot | @ghisvail | @pre-commit-ci | @welcome
v1.1.0 -- 2023-12-19#
Enhancements made#
Bugs fixed#
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)
Maintenance and upkeep improvements#
Documentation improvements#
Other merged PRs#
[pre-commit.ci] pre-commit autoupdate #789 (@pre-commit-ci)
Build(deps): Bump pypa/gh-action-pypi-publish from 1.8.10 to 1.8.11 #785 (@dependabot)
[pre-commit.ci] pre-commit autoupdate #783 (@pre-commit-ci)
RLS: v1.1.0rc1 #780 (@choldgraf)
[pre-commit.ci] pre-commit autoupdate #779 (@pre-commit-ci)
Update style.md #774 (@callezenwaka)
Update launch.md #773 (@callezenwaka)
[pre-commit.ci] pre-commit autoupdate #772 (@pre-commit-ci)
Make article width take up whole page in absence of secondary sidebar #771 (@flying-sheep)
Build(deps): Bump actions/checkout from 3 to 4 #764 (@dependabot)
Build(deps): Bump pypa/gh-action-pypi-publish from 1.8.7 to 1.8.10 #755 (@dependabot)
[pre-commit.ci] pre-commit autoupdate #748 (@pre-commit-ci)
Build(deps): Bump pypa/gh-action-pypi-publish from 1.8.6 to 1.8.7 #747 (@dependabot)
update python requirements according to NEP 29 #741 (@akhmerov)
Build(deps): Bump pypa/gh-action-pypi-publish from 1.8.4 to 1.8.6 #739 (@dependabot)
Build(deps): Bump codecov/codecov-action from 3.1.1 to 3.1.4 #738 (@dependabot)
Build(deps): Bump treosh/lighthouse-ci-action from 9.3.1 to 10.1.0 #725 (@dependabot)
Build(deps): Bump treosh/lighthouse-ci-action from 9.3.1 to 9.6.8 #718 (@dependabot)
Build(deps): Bump pypa/gh-action-pypi-publish from 1.6.4 to 1.8.4 #717 (@dependabot)
RLS: v1.0.1 #716 (@AakashGfude)
[pre-commit.ci] pre-commit autoupdate #705 (@pre-commit-ci)
[ENH, DOC] Allow setting the
navbar_max_depth
andcollapse_navbar
#605 (@gilbertbw)
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#
PyData Sphinx Theme
v0.13
. See the PyData Sphinx Themev0.13
release notes for details.Icon links, more source providers, and bug fixes #691 (@choldgraf, @mmcky)
We now support GitHub, GitLab, and BitBucket source providers.
You can now include lists of icon links in your primary sidebar.
Allowing inline elements in sidenotes and marginnotes #641 (@AakashGfude)
Improve Chinese (Taiwan) and Chinese (China) translation #585 (@whyjz)
sphinx >=4,<6 #644 (@AakashGfude)
Bugs fixed#
FIX: Scroll padding on top for anchor links #669 (@choldgraf)
🐛 FIX: Correcting a broken link in CHANGELOG.md #623 (@AakashGfude)
[FIX] Use logo url as is to allow for web urls. #661 (@feanil)
Maintenance and upkeep improvements#
MAINT: Update pre-commit versions and fix minor bugs in tests #660 (@choldgraf)
MAINT: Move dependabot updates to monthly #658 (@choldgraf)
MAINT: Factor publish to pypi workflow into dedicated file #645 (@choldgraf)
MAINT: Remove duplication with pydata-sphinx-theme #640 (@choldgraf)
MAINT: remove incorrect comment from sphinx pin. #588 (@rossbar)
IntersectionObserver at 1/3 screen #567 (@choldgraf)
Documentation improvements#
DOC: Update kitchen sink #610 (@choldgraf)
Breaking changes to structure and API#
UPGRADE/BREAKING: PyData v0.13 and HTML refactoring #677 (@choldgraf)
Remove JQuery and update versions #668 (@choldgraf)
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:#
Style edits for last-child zero-margin on dd's #586 (@benjaoming)
Escape colon in JupyterHub link to repo #556 (@matthew-brett)
Myst-nb pinning to 0.13.2 #560 (@choldgraf)
Stylizing ReadTheDocs in
_readthedocs.scss
as per guidelines #579 (@pradyunsg)templates_path
in config was overriding any value append totemplates_path
in this package. #566 (@AakashGfude)
Enhancements made:#
Added sidenote and marginnote using footnote syntax #546 (@AakashGfude)
Docs:#
Added Docs for sphinx-examples #550 (@choldgraf)
Lychee link fixes #553 (@choldgraf)
Beta and lychee link fix #552 (@choldgraf)
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.
Enhancements made#
‼️ REFACTOR: HTML and CSS restructuring #472 (@choldgraf)
ENH: Standardize scrollbar behavior #481 (@choldgraf)
ENH: Standardize header buttons #490 (@choldgraf)
ENH: Updating search page style #491 (@choldgraf)
ENH: Add CSS for comments libraries #524 (@choldgraf)
ENH: Add support for ReadTheDocs popup #518 (@choldgraf)
STYLE: Search color highlighting in-line with Jupyter orange #532 (@choldgraf)
‼️ 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#
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#
Enhancements made#
Add pst prefix to variables #413 (@choldgraf)
Note TOC level auto-show #410 (@choldgraf)
Add note of margin CSS classes #405 (@choldgraf)
v0.1.5 - 2021-09-23#
Enhancements made#
Move CSS hash to GET parameter so downstream themes can bust CSS properly #397 (@jacobtomlinson)
v0.1.4 - 2021-09-16#
Enhancements made#
⬆️ UPGRADE: Sphinx v4.0.0 #364 (@choldgraf)
✨ IMPROVE: Harmonize themes between static and live code #393 (@patrickmineault)
✨ IMPROVE: Minor tweaks to footer css #389 (@choldgraf)
v0.1.3 - 2021-08-25#
Enhancements made#
✨ IMPROVE: Add chevrons to prev/next #386 (@choldgraf)
✨ IMPROVE: Improving accessibility labeling #375 (@choldgraf)
Bugs fixed#
🐛 FIX: Fix translation for prev/next #384 (@choldgraf)
v0.1.1...v0.1.2 - 2021-08-06#
v0.1.0...v0.1.1#
New features added#
Add logo_only theme option #349 (@djangoliv)
Enhancements made#
Add css to highlight searched for phrases #350 (@sanjayankur31)
Add logo_only theme option #349 (@djangoliv)
Soften edges in admonitions and remove some ink #352 (@choldgraf)
Bugs fixed#
🐛 FIX: Path to custom output directory for _sources #346 (@dfm)
🐛 FIX: Fixing sidebar animation #333 (@choldgraf)
v0.0.42...v0.1.0#
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#
✨ ENH: Adding fullscreen button optional #328 (@choldgraf)
Bugs fixed#
🐛 FIX: Fixing sidebar scroll #311 (@choldgraf)
API and Breaking Changes#
⬆ UPGRADE: Pydata Sphinx Theme v0.6.0 #324 (@choldgraf)
Deprecated features#
DEPRECATE: Removing opengraph functionality #316 (@choldgraf)
v0.0.42 2021-03-13#
Bugs fixed#
v0.0.41 2021-03-09#
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#
New features added#
Added tag for cell-input #259 (@AakashGfude)
Add a shadow to header, on scroll #255 (@pradyunsg)
Enhancements made#
Add footnote translations #274 (@chrisjsewell)
Bugs fixed#
translation of suggest edit #284 (@chrisjsewell)
Pin bs4 and sphinx dependencies #271 (@chrisjsewell)
fixing right toc whitespace overlap #268 (@choldgraf)
Fixing linenos style #263 (@AakashGfude)
v0.0.39 - 2020-11-08#
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#
Option for download button #245 (@bknaepen). The "download" button used to be automatically added, but can now be removed. See the download button configuration.
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#
v0.0.34...v0.0.35#
Enhancements 👌#
Change "On this page" -> "Contents" #159 (@pradyunsg)
Use consistent font size in toc #157 (@pradyunsg)
Consistent font size in navigation #156 (@pradyunsg)
Bugs fixed 🐛#
backref superscript #171 (@AakashGfude)
Fixing sidebar overlap on narrow screens #167 (@choldgraf)
Fixing jupyterhub urls #166 (@choldgraf)
Create parent folders, when adding notebook to sources #152 (@pradyunsg)
Documentation improvements 📚#
Adding contributing docs #163 (@choldgraf)
Contributors to this release#
(GitHub contributors page for this release)
@AakashGfude | @choldgraf | @chrisjsewell | @pradyunsg | @welcome