2.0.0a0

(Full Changelog)

Enhancements made

• ✏️ Hardcode binary name #2253 (@agoose77)
• 🪐 Make jupyter a dependency #2245 (@agoose77)
• ⚙️ Add support for nodeenv, and build JS CLI #2219 (@agoose77)

Bugs fixed

• 🐜 Fix reference to deleted directives #2251 (@agoose77)

Maintenance and upkeep improvements

• 📝 Add simple CI testing of CLI version #2262 (@agoose77)
• 📦 Install before clean during release #2261 (@agoose77)
• 🛠️ Set up Node.js version handling #2260 (@agoose77)
• 🪨 Bump version to 2.0.0a0 #2258 (@agoose77)
• 🤖 Add jupyter releaser #2257 (@agoose77)
• 🖇️ Use shared config in docs #2243 (@agoose77)
• ❄️ Add Nix devshell flake #2221 (@agoose77)

Documentation improvements

• ✏️ Remove references to executablebooks #2255 (@choldgraf)
• 🌍 Add documentation about plugin origin #2252 (@agoose77)
• ✨ Iterate on next docs #2250 (@agoose77)
• ❔ Add tutorials to Jupyter Book 2.0 docs #2249 (@choldgraf)
• 💼 More docs improvements #2248 (@agoose77)
• 📙 Next documentation improvements #2244 (@agoose77)
• 🖇️ Use shared config in docs #2243 (@agoose77)
• 🔗 Fix GitHub URL #2241 (@agoose77)
• 🖇️ Use shared config for myst.yml #2240 (@agoose77)
• 📔 Add note about 2.0 to README #2224 (@agoose77)
• ⚙️ Drop BASE_URL in GitHub Pages #2223 (@agoose77)
• 📔 Simplify readme #2222 (@agoose77)

Contributors to this release

(GitHub contributors page for this release)

@agoose77 | @choldgraf | @codecov | @jmshea | @LoicGrobol | @psychemedia | @welcome

v1.0.3 - 2024-10-07

(full changelog)

New features added

• FEAT: ✨Add Launch in Deepnote button setting #1434 (@jakubzitny)

Bugs fixed

• FIX: bring tests in line with config #2216 (@agoose77)
• FIX: update default config #2195 (@agoose77)
• FIX: pull in config for plausible #2179 (@agoose77)

Maintenance and upkeep improvements

• MAINT: bump version #2229 (@agoose77)
• MAINT: only use v1 job for v1 releases #2225 (@agoose77)
• MAINT: bump version #2168 (@agoose77)
• MAINT: update entry-points usage #2121 (@agoose77)
• MAINT: bump sphinx-thebe LB #2116 (@agoose77)

Documentation improvements

• DOCS: fall-back to fontawesome in LaTeX (and format _config) #2228 (@agoose77)
• DOCS: fix incorrect link #2212 (@brownsarahm)
• DOCS: update readme to point to blog post #2198 (@agoose77)
• DOCS: add note about MyST-MD #2197 (@agoose77)
• DOCS: update readme with note about maintenance #2196 (@agoose77)
• DOCS: add structured data example #2129 (@jmshea)
• DOCS: update citations document #2108 (@drsimonmartin)

Contributors to this release

(GitHub contributors page for this release)

@agoose77 | @brownsarahm | @bryanwweber | @choldgraf | @codecov | @drsimonmartin | @jakubzitny | @jmshea | @LoicGrobol | @MortenHannemose | @psychemedia | @welcome

v1.0.2 - 2024-06-27

(full changelog)

Bugs fixed

• FIX: schema for bibfiles #2163 (@agoose77)

Maintenance and upkeep improvements

• MAINT: bump version #2168 (@agoose77)
• MAINT: enable workflow-dispatch on tests #2165 (@agoose77)
• MAINT: disable codecov uploader #2161 (@agoose77)
• MAINT: bump version #2156 (@agoose77)

Documentation improvements

• DOCS: fix glue of NumPy variables #2167 (@agoose77)

Other merged PRs

• TEST: update sphinx==5 tests #2166 (@agoose77)

Contributors to this release

(GitHub contributors page for this release)

@agoose77 | @sbwiecko | @welcome

v1.0.1 - 2024-05-28

(full changelog)

Bugs fixed

• FIX: revert removal of sphinx-book-theme from default config #2155 (@agoose77)
• FIX: ignore DeprecationWarning for latexcodec #2154 (@agoose77)
• FIX: alias renamed field google_analytics_id #2151 (@agoose77)
• FIX: Remove sphinx-book-theme from extensions #2111 (@ghisvail)

Maintenance and upkeep improvements

• MAINT: bump version #2156 (@agoose77)

Documentation improvements

• DOCS: fix link to jupytext #2131 (@fkohrt)
• DOCS: apply recursive_update #2114 (@agoose77)
• DOCS: update gh-pages.md #2109 (@joaomh)

Other merged PRs

• TEST: fixes for adjusted configuration #2117 (@agoose77)
• build(deps): bump actions/checkout from 3 to 4 #2083 (@dependabot)

Contributors to this release

(GitHub contributors page for this release)

@agoose77 | @bryanwweber | @CalMacCQ | @choldgraf | @chrisjsewell | @codecov | @dependabot | @domoritz | @effigies | @fkohrt | @ghisvail | @isabelizimm | @iso2013 | @jackminchin | @janash | @jmshea | @joaomh | @mgeier | @mmann1123 | @mmcky | @parmentelat | @VRConservation | @welcome

v1.0.0 - 2024-01-26

(full changelog)

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!

Bugs fixed

• FIX: update output_scroll tag #2050 (@agoose77)
• RELEASE: v0.15.1 + BUG: Issue warning for sphinxcontrib-bibtex + docutils>=0.18,<0.20 #1965 (@mmcky)

Maintenance and upkeep improvements

• MAINT: prepare for 1.0 release #2089 (@agoose77)
• MAINT: adding python 3.10 to the testing matrix and tox #1987 (@bsipocz)

Documentation improvements

• DOCS: describe new GHA workflow #2080 (@agoose77)
• DOCS: fix broken URL #2072 (@PhilippKaniuth)
• DOCS: _config.yml: clarify CSS-breakage announcement #2070 (@SamB)
• DOCS: trigger deploy-book action on both master and main #2057 (@kolibril13)
• DOCS: update new-file.md #2056 (@RichardLitt)
• DOCS: update MyST eval_rst directive guide link #2040 (@nikosavola)
• DOCS: update copyright year to 2023 #2029 (@GlobalMin)
• DOCS: fix minor format error in TOC documentation #2028 (@mwcraig)
• DOCS: typo fixes and formatting for migration.md #2018 (@delfanbaum)
• DOCS: update markdown.md #2014 (@chbrandt)
• DOCS: comments.md: add link to https://dokie.li/ #2001 (@westurner)
• DOCS: persist execution cache on github actions #1998 (@minrk)
• DOCS: Add documentation about suppressing warnings for showing plotly figures #1957 (@finsberg)

Other merged PRs

• build(deps): bump actions/cache from 3 to 4 #2104 (@dependabot)
• build(deps): bump actions/setup-python from 4 to 5 #2084 (@dependabot)
• build(deps): bump actions/checkout from 3 to 4 #2083 (@dependabot)
• build(deps): bump codecov/codecov-action from 3.1.3 to 3.1.4 #2019 (@dependabot)
• build(deps): bump codecov/codecov-action from 3.1.2 to 3.1.3 #2005 (@dependabot)
• build(deps-dev): update sphinx-design requirement from ~=0.3.0 to ~=0.4.1 #2000 (@dependabot)
• build(deps): bump codecov/codecov-action from 3.1.1 to 3.1.2 #1999 (@dependabot)
• [pre-commit.ci] pre-commit autoupdate #1989 (@pre-commit-ci)
• Update config.py for sphinx_multitoc_numbering #1799 (@whyjz)

Contributors to this release

(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](https://github.com/search?q=repo%3Aexecutablebooks%2Fjupyter-book+involves%3Awesturner+updated%3A2023-03-14.....

v0.15.1 - 2023-03-13

(full changelog)

Bug

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.

• #1965

Bug: Using docutils>=0.18 results in breaking the page html layout when using sphinx-book-theme on pages
that include a bibliography directive.

v0.15.0 - 2023-03-07

(full changelog)

This release updates sphinx-book-theme to version 1.0.0

• #1953

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

v0.14.0 - 2023-02-28

(full changelog)

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.

Package Updates

• #1842 updates myst-nb moving from 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.
• #1842 enables compatibility with docutils>=0.15,<0.19
• #1842 supports sphinx5
• #1842 incorporates updates for sphinx-design, sphinx-thebe and sphinx-book-theme.

Docs

• DOCS: Fix gallery URL 1933 and 1937

Contributors to this release

(GitHub contributors page for this release)

However this excludes the many major contributions in underlying projects which are documented in the table below.

(full changelog)

Bugs fixed

• FIX: Address typo in docs #1841 (@mmcky)

Maintenance and upkeep improvements

• MAINT: Remove cell_metadata_filter: -all from template #1910 (@maxbane)
• MAINT: Move pypi publish to dedicated workflow #1878 (@choldgraf)

Documentation improvements

• DOCS: Fix typo #1879 (@fortierq)
• DOCS: Add copybutton console prefix #1877 (@choldgraf)
• DOCS: Fix broken link in pdf.md #1876 (@stoffprof)
• DOCS: document an easier method of plausible analytics #1867 (@rkdarst)
• DOCS: Clarify toc update tip #1861 (@root-11)
• DOC: Add guidance for configuring gh-pages #1859 (@rafmudaf)
• DOCS: Remove incomplete documentation section on adding metadata #1854 (@MaxGhenis)
• DOCS: Updates to Read the Docs instructions #1849 (@benjaoming)
• DOCS: Add an example of admonition with warning style #1834 (@paugier)
• DOCS: Add documentation on enabling Plausible Analytics #1814 (@firasm)
• DOCS: Improve custom admonitions documentation #1777 (@leodrivera)
• DOCS: Change syntax highlighting example #1752 (@fmaussion)
• DOCS: Add link to default myst extensions #1908 (@jbusecke)

Contributors

@mmcky
@maxbane
@choldgraf
@fortierq
@stoffprof
@rkdarst
@root
@rafmudaf
@MaxGhenis
@benjaoming
@paugier
@firasm
@leodrivera
@fmaussion
@jbusecke

v0.13.1 - 2022-08-16

(full changelog)

This minor release includes improvements to the project documentation and includes the following fixes:

Fixes and Maintenance

1. #1750 improves compatibility with sphinx>=5.
2. #1774 fixes an issue that enables math when using the singlehtml builder