v1.0.0rc2

See https://github.com/executablebooks/sphinx-book-theme/releases/tag/v1.0.0rc1 for release notes

v1.0.0rc1

A release candidate for v1.0 of this theme. We're making it 1.0 because there are several major breaking changes!

pip install -U --pre sphinx-book-theme

Leave comments in this issue:

• #686

Release notes (work in progress)

Enhancements made

• ENH: sphinx >=4,<6 #644 (@AakashGfude)
• ENH: Allowing inline elements in sidenotes and marginnotes #641 (@AakashGfude)
• ENH: Improve Chinese (Taiwan) and Chinese (China) translation #585 (@whyjz)

Bugs fixed

• FIX: Scroll padding on top for anchor links #669 (@choldgraf)
• 🐛 FIX: Correcting a broken link in CHANGELOG.md #623 (@AakashGfude)
• FIX: Scroll to active navigation item #609 (@ksuess)

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)

Documentation improvements

• DOCS: Minor typo correction #649 (@bmorris3)
• DOC: Update kitchen sink #610 (@choldgraf)

API and Breaking Changes

• UPGRADE/BREAKING: PyData v0.13 and HTML refactoring #677 (@choldgraf)

Other merged PRs

• [pre-commit.ci] pre-commit autoupdate #676 (@pre-commit-ci)
• Remove JQuery and update versions #668 (@choldgraf)
• [RLS] Pre-release 0.4.0rc1 #666 (@choldgraf)
• Build(deps-dev): Update pre-commit requirement from <2.21,>=2.7 to >=2.7,<2.22 #662 (@dependabot)
• [FIX] Use logo url as is to allow for web urls. #661 (@feanil)
• Build(deps): Bump pypa/gh-action-pypi-publish from 1.6.1 to 1.6.4 #657 (@dependabot)
• Build(deps): Bump pypa/gh-action-pypi-publish from 1.5.1 to 1.6.1 #653 (@dependabot)
• Build(deps-dev): Update pre-commit requirement from ~=2.7.0 to >=2.7,<2.21 #643 (@dependabot)
• Build(deps): Bump treosh/lighthouse-ci-action from 9.3.0 to 9.3.1 #642 (@dependabot)
• [pre-commit.ci] pre-commit autoupdate #637 (@pre-commit-ci)
• Build(deps-dev): Update pytest-regressions requirement from ~=2.0.1 to >=2.0.1,<2.5.0 #634 (@dependabot)
• Build(deps-dev): Update pytest-cov requirement from ~=3.0 to >=3,<5 #632 (@dependabot)
• Add project URLs to pyproject.toml #631 (@rkdarst)
• [pre-commit.ci] pre-commit autoupdate #627 (@pre-commit-ci)
• Open launch buttons in new window #626 (@guillaume-haerinck)
• [pre-commit.ci] pre-commit autoupdate #621 (@pre-commit-ci)
• Bump the version of pytest for compatibility with python 3.10 #620 (@ZedThree)
• Build(deps): Bump codecov/codecov-action from 3.1.0 to 3.1.1 #615 (@dependabot)
• [pre-commit.ci] pre-commit autoupdate #604 (@pre-commit-ci)
• [pre-commit.ci] pre-commit autoupdate #599 (@pre-commit-ci)
• Build(deps): Bump pypa/gh-action-pypi-publish from 1.5.0 to 1.5.1 #598 (@dependabot)
• Update pydata theme to 0.10 #597 (@AakashGfude)
• RLS: v0.3.3 #589 (@AakashGfude)
• [pre-commit.ci] pre-commit autoupdate #576 (@pre-commit-ci)
• Build(deps): Bump actions/setup-python from 3 to 4 #570 (@dependabot)
• Build(deps): Bump pre-commit/action from 2.0.3 to 3.0.0 #568 (@dependabot)
• IntersectionObserver at 1/3 screen #567 (@choldgraf)

Contributors to this release

(GitHub contributors page for this release)

@12rambau, @AakashGfude, @AllenDowney, @avivajpeyi, @bmorris3, @choldgraf, @chrisjsewell, @consideRatio, @dependabot, @feanil, @ghutchis, @guillaume, @haklc, @ivirshup, @James11222, @ksuess, @mathbunnyru, @melund, @mmcky, @pradyunsg, @pre, @rkdarst, @rossbar, @scmmmh, @sieler, @SilverRainZ, @stevepiercy, @WELCOME, @whyjz, @yuvipanda, @ZedThree

[pre-release] v0.4.0rc1

This is a pre-release for an upcoming major version change of this theme.

v0.3.3

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 to templates_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

RLS: v0.3.2 (#543)

v0.3.1

A patch release to fix a few UI bugs.

v0.3.0

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

• ‼️ 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.3.0rc2

This brings in some extra improvements to the sidebar's behavior and fixes some bugs from the first release candidate. See https://github.com/executablebooks/sphinx-book-theme/releases/tag/v0.3.0rc1 for more changes.

v0.3.0rc1 - pre-release

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

• ‼️ 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)

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)

Full Changelog: v0.1.10...v0.2.0