Bump sphinx-book-theme from 0.3.3 to 1.0.0
Created by: dependabot[bot]
Bumps sphinx-book-theme from 0.3.3 to 1.0.0.
Release notes
Sourced from sphinx-book-theme's releases.
v1.0.0
This is a major release that brings in the latest PyData Sphinx Theme, Bootstrap 5, and updates many features.
See the Sphinx Book Theme changelog for details.
Contributors
@12rambau
(activity) |@AakashGfude
(activity) |@akhmerov
(activity) |@AllenDowney
(activity) |@avivajpeyi
(activity) |@bmorris3
(activity) |@choldgraf
(activity) |@chrisjsewell
(activity) |@consideRatio
(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) |@rkdarst
(activity) |@rossbar
(activity) |@scmmmh
(activity) |@sieler
(activity) |@SilverRainZ
(activity) |@stevepiercy
(activity) |@trallard
(activity) |@whyjz
(activity) |@yuvipanda
(activity) |@ZedThree
(activity)v1.0.0rc3
See https://github.com/executablebooks/sphinx-book-theme/releases/tag/v1.0.0rc1 for release notes
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:
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
... (truncated)
Changelog
Sourced from sphinx-book-theme's changelog.
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: Scroll to active navigation item #609 (
@ksuess
)- [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
- DOCS: Minor typo correction #649 (
@bmorris3
)- 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; </tr></table>
... (truncated)
Commits
-
6601a2f
RLS 1.0.0: (repeat) Fix a link and improve test reliability (#701) -
b84dc6b
RLS: v1.0.0 (#699) -
6469079
PyData release update (#698) -
c98de28
ENH: Add translation to page element (#695) -
996fa65
RLS: v1.0.0rc3 -
9e2bc2f
NEH: Icon links, latest PST, more source providers, and bug fixes (#691) -
30d0c2d
Fix: logo image stretching vertically (#689) -
70e8ade
Better early return for add_launch_buttons if no launch buttons (#693) -
282f14e
RLS: v1.0.0rc2 -
7c2a378
ENH: Improvements after v1.0.0rc1 feedback (#687) - Additional commits viewable in compare view
Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase
.
Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR:
-
@dependabot rebase
will rebase this PR -
@dependabot recreate
will recreate this PR, overwriting any edits that have been made to it -
@dependabot merge
will merge this PR after your CI passes on it -
@dependabot squash and merge
will squash and merge this PR after your CI passes on it -
@dependabot cancel merge
will cancel a previously requested merge and block automerging -
@dependabot reopen
will reopen this PR if it is closed -
@dependabot close
will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually -
@dependabot ignore this major version
will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) -
@dependabot ignore this minor version
will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) -
@dependabot ignore this dependency
will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)