Create beautiful, publication-quality books and documents from computational content.
This release represents a stabilisation of the jupyter-book ecosystem. It features updates to many of the underlying software packages used by jupyter-book
, including "major" updates to myst-nb and myst-parser which power jupyter-book
. This release also brings compatibility with sphinx v7
.
A big thank you to all contributors and maintainers of these underlying packages!
[!IMPORTANT]
This release brings in updates tomyst-parser
. A notable change is that of the markdown link syntax, which was extended to support more constructs. The syntax behind this change is outlined in https://mep.mystmd.org/en/latest/meps/mep-0002/.
output_scroll
tag #2050 (@agoose77)eval_rst
directive guide link #2040 (@nikosavola)(GitHub contributors page for this release)
@AakashGfude | @agoose77 | @ashejim | @blakeNaccarato | @bsipocz | @chbrandt | @choldgraf | @chrisjsewell | @codecov | @delfanbaum | @dependabot | @finsberg | @firasm | @GlobalMin | @jorgensd | @kolibril13 | @marcdexet-cnrs | @mathieuboudreau | @minrk | @mmcky | @mwcraig | @nikosavola | @nocomplexity | @PhilippKaniuth | @phockett | @pre-commit-ci | @RichardLitt | @SamB | @welcome | @westurner | @whyjz | @zingale
This release is a minor update to alert users of jupyter-book
to sphinxcontrib-bibtex #322 when building bibliographies with docutils>=0.18,<0.20
installed.
Bug: Using docutils>=0.18
results in breaking the page html
layout when using sphinx-book-theme
on pages
that include a bibliography
directive.
This release updates sphinx-book-theme to version 1.0.0
The full release notes for sphinx-book-theme==1.0.0 can be found here
Thanks to all the contributors that worked on this major update to sphinx-book-theme
This release updates many of the underlying software packages used by jupyter-book
including major updates to myst-nb and myst-parser which power jupyter-book
. This release also brings compatibility with sphinx v5
.
A big thank you to all contributors and maintainers of these underlying packages. There have been many major updates that will flow through to jupyter-book
with this release.
A migration assistance page has been setup to assist users with updates to your configuration
and highlights a few of the common breaking changes
which are discussed with examples.
myst-nb~=0.13.1
to myst-nb~=0.17.1
. This incorporates three major updates to myst-nb which in turn incorporates changes to the underlying myst-parser moving from myst-parser~=0.15
to myst-parser~=0.18
.docutils>=0.15,<0.19
sphinx5
sphinx-design
, sphinx-thebe
and sphinx-book-theme
.(GitHub contributors page for this release)
However this excludes the many major contributions in underlying projects which are documented in the table below.
Package | Contributions |
---|---|
myst-nb | contributors |
myst-parser | contributors |
sphinx-design | contributors |
sphinx-thebe | contributors |
sphinx-book-theme | contributors |
cell_metadata_filter: -all
from template #1910 (@maxbane)@mmcky @maxbane @choldgraf @fortierq @stoffprof @rkdarst @root @rafmudaf @MaxGhenis @benjaoming @paugier @firasm @leodrivera @fmaussion @jbusecke
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.
#1442 Use Sphinx Design instead of Sphinx Panels. We have migrated from sphinx-panels to 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 for more information on upgrades and usage.
#1679 Update Sphinx Book Theme to v0.3. 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.
See the Book Theme release notes as well as the Book Theme changelog for more information.
#1693 Removes support for sphinx<=4
. This will likely only be applicable to you if you were explicitly pinning Sphinx to a version less than 4.
This is a minor release, primarily to fix a bug where incorrect Jinja version pinning leads to broken builds. It also updates our build system to use flit
and follow the pyproject.toml
standard.
This is a minor release that bumps the versions of several dependencies in Jupyter Book (see below for details).
v0.4.*
#1513 (@bryanwweber)v0.1.*
#1634 (@choldgraf)v8.*
#1623 (@lukasbindreiter)This release primarily brings improvements to pdf
via LaTeX
output for code-cells
See the CHANGELOG for more details