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](https://github.com/executablebooks/sphinx-book-theme/compare/v0.2.0...d9c1abc4197445faab7892291520de448f363274))
Enhancements made
- ‼️ REFACTOR: HTML and CSS restructuring [472](https://github.com/executablebooks/sphinx-book-theme/pull/472) ([choldgraf](https://github.com/choldgraf))
- ENH: Standardize scrollbar behavior [481](https://github.com/executablebooks/sphinx-book-theme/pull/481) ([choldgraf](https://github.com/choldgraf))
- ENH: Standardize header buttons [490](https://github.com/executablebooks/sphinx-book-theme/pull/490) ([choldgraf](https://github.com/choldgraf))
- ENH: Updating search page style [491](https://github.com/executablebooks/sphinx-book-theme/pull/491) ([choldgraf](https://github.com/choldgraf))
- ENH: Add CSS for comments libraries [524](https://github.com/executablebooks/sphinx-book-theme/pull/524) ([choldgraf](https://github.com/choldgraf))
- ENH: Add support for ReadTheDocs popup [518](https://github.com/executablebooks/sphinx-book-theme/pull/518) ([choldgraf](https://github.com/choldgraf))
- STYLE: Search color highlighting in-line with Jupyter orange [532](https://github.com/executablebooks/sphinx-book-theme/pull/532) ([choldgraf](https://github.com/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](https://developer.mozilla.org/en-US/docs/Web/API/Intersection_Observer_API) which will reduce the number of JavaScript calls and improve reliability of this feature. [#448](https://github.com/executablebooks/sphinx-book-theme/pull/448) ([choldgraf](https://github.com/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](https://github.com/executablebooks/sphinx-book-theme/pull/454) ([choldgraf](https://github.com/choldgraf))
- You can now add Deepnote buttons for notebook launch buttons [385](https://github.com/executablebooks/sphinx-book-theme/pull/385) ([jakubzitny](https://github.com/jakubzitny))