Skip to content
Snippets Groups Projects
Unverified Commit c3ca62ef authored by mmcky's avatar mmcky Committed by GitHub
Browse files

Update CHANGELOG.md


Co-authored-by: default avatarChris Holdgraf <choldgraf@berkeley.edu>
parent 65cc4370
Branches v0.13
No related tags found
No related merge requests found
......@@ -4,18 +4,15 @@
([full changelog](https://github.com/executablebooks/jupyter-book/compare/v0.12.3...a2d441633d5aafed4e94bbc544183cf866213f3a))
This release contains breaking changes as we have migrated from [sphinx-panels](https://github.com/executablebooks/sphinx-panels)
to [sphinx-design](https://github.com/executablebooks/sphinx-design) as that will be the package being maintained into the future
to provide design and layout customization elements for `html` builds.
This release contains some major UI and visual style upgrades for HTML output, and introduces some breaking changes in a few directives and in the structure of the HTML. See below for major changes.
### New and Breaking ‼
1. [#1442 Use Sphinx Design instead of Sphinx Panels](https://github.com/executablebooks/jupyter-book/pull/1442).
2. [#1693 Removes support for `sphinx<=4`](https://github.com/executablebooks/jupyter-book/pull/1693).
3. [#1679 Update Sphinx Book Theme to v0.3](https://github.com/executablebooks/jupyter-book/pull/1679). This update includes some breaking changes for the `HTML` structure of some major theme sections (i.e. sidebars and top-bar) which will impact custom css.
1. [#1442 Use Sphinx Design instead of Sphinx Panels](https://github.com/executablebooks/jupyter-book/pull/1442). We have migrated from [sphinx-panels](https://github.com/executablebooks/sphinx-panels) to [sphinx-design](https://github.com/executablebooks/sphinx-design), as `sphinx-panels` is no longer actively maintained. This also brings in several improvements to the same component functionality that was in sphinx-panels. See [the components documentation](https://jupyterbook.org/en/latest/content/components.html) for more information on upgrades and usage.
2. [#1679 Update Sphinx Book Theme to v0.3](https://github.com/executablebooks/jupyter-book/pull/1679). This brings in several major upgrades to the theme's behavior and structure. It significantly changes the structure of the output HTML (in particular, the sidebars and article header), so if you defined custom CSS rules, double-check that they still apply correctly.
The full set of changes to sphinx-book-theme
are available on [the sphinx-book-theme changelog](https://github.com/executablebooks/sphinx-book-theme/blob/master/CHANGELOG.md#v030---2022-03-25).
See [the Book Theme release notes](https://github.com/executablebooks/sphinx-book-theme/releases/tag/v0.3.0) as well as [the Book Theme changelog](https://github.com/executablebooks/sphinx-book-theme/blob/master/CHANGELOG.md#v030---2022-03-25) for more information.
3. [#1693 Removes support for `sphinx<=4`](https://github.com/executablebooks/jupyter-book/pull/1693). This will likely only be applicable to you if you were explicitly pinning Sphinx to a version less than 4.
## v0.12.3 - 2022-03-28
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment