Two patch releases fixed two bugs for figure content in the margin.
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
stickyand 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.
‼️ 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)
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.
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)
Maintenance release, to remove the unused click dependency.
This is a minor release to fix a bug that was introduced which broke the right sidebar anchor links.
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
Full Changelog: https://github.com/executablebooks/sphinx-book-theme/compare/v0.1.6...v0.1.7
This release primarily updates the pydata theme to bring in a few new theme features and bug-fixes.
- UPDATE: pydata sphinx theme v0.7.2 by @ocefpaf in executablebooks#406
- UPDATE: pydata-sphinx-theme 0.7.2 by @kousu in executablebooks#429
- IMPROVE: translation in the footer for Japanese language by @KengoTODA in executablebooks#426
- Add pst prefix to variables #413 (@choldgraf)
- Note TOC level auto-show #410 (@choldgraf)
- Add note of margin CSS classes #405 (@choldgraf)
- Move CSS hash to GET parameter so downstream themes can bust CSS properly #397 (@jacobtomlinson)
- ⬆️ 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)
- ✨ IMPROVE: Add chevrons to prev/next #386 (@choldgraf)
- ✨ IMPROVE: Improving accessibility labeling #375 (@choldgraf)
- ✨ IMPROVE: improve math styling #369 (@akhmerov)
- 🐛 FIX: Fix translation for prev/next #384 (@choldgraf)
- 🔧 MAINT: Reduce
full-widthfrom 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
- Add logo_only theme option #349 (@djangoliv)
- 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)
- 🐛 FIX: Path to custom output directory for _sources #346 (@dfm)
- 🐛 FIX: Fixing sidebar animation #333 (@choldgraf)
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.
- ✨ ENH: Adding fullscreen button optional #328 (@choldgraf)
- 🐛 FIX: Fixing sidebar scroll #311 (@choldgraf)
- ⬆ UPGRADE: Pydata Sphinx Theme v0.6.0 #324 (@choldgraf)
- DEPRECATE: Removing opengraph functionality #316 (@choldgraf)
- The Table of Contents titles is now configurable. See #299 (@AakashGfude)
- The left sidebar has a drawer-style layout on mobile. See #298 (@DrDrij)
- Added tag for cell-input #259 (@AakashGfude)
- Add a shadow to header, on scroll #255 (@pradyunsg)
- Add CSS to center align images with class #292 (@DrDrij)
- Add footnote translations #274 (@chrisjsewell)
- 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)
- sphinx sidebars functionality #233 (@choldgraf). You can now use the
html_sidebarsfunctionality 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.
- Option for download button #245 (@bknaepen). The "download" button used to be automatically added, but can now be removed. See the download button configuration.
👌 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)
✨ 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)
(GitHub contributors page for this release)
@choldgraf | @chrisjsewell | @fm75 | @hason | @najuzilu | @nathancarter | @pauleveritt | @pradyunsg |
👌 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.
- Change "On this page" -> "Contents" #159 (@pradyunsg)
- Use consistent font size in toc #157 (@pradyunsg)
- Consistent font size in navigation #156 (@pradyunsg)
- 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)
- Adding contributing docs #163 (@choldgraf)
(GitHub contributors page for this release)
@AakashGfude | @choldgraf | @chrisjsewell | @pradyunsg | @welcome