Releases: jupyter-book/jupyter-book
v0.7.1
v0.7.0
This is a total re-write of the back-end of Jupyter Book, which is now built on Sphinx. See
the Jupyter Book wiki for an upgrade guide, and the jupyterbook docs for information about the new jupyter book.
v0.6.5...v0.7.0
Merged PRs
- Release prep #711 (@choldgraf)
- fixing topbar repo buttons #710 (@choldgraf)
- [DOC] Add info about 'remove_cell' tag #708 (@najuzilu)
- [DOC] Fix broken Jupytext link #703 (@najuzilu)
- misc doc improvements #702 (@choldgraf)
- fixing toc bug #696 (@choldgraf)
- [DOC, ENH] Shorten descriptions of clean and toc functions #693 (@pgadige)
- execution error doc #691 (@choldgraf)
- [DOC] Fix rendering of subitems in ordered list #686 (@najuzilu)
- adding configuration for source buttons #684 (@choldgraf)
- adding versions #679 (@choldgraf)
- ENH: Modify execute option for jb page command (#594 followup) #678 (@rossbar)
- fixing suffix in download files #656 (@choldgraf)
- config defaults #654 (@choldgraf)
- Additional latex newcommand example #652 (@najuzilu)
- How to reference docs and section labels #651 (@najuzilu)
- TST: minor update to reference book.pdf rather than python.pdf #650 (@mmcky)
- improving configuration under the hood #647 (@choldgraf)
- draft windows instructions #642 (@phaustin)
- [DOC] MyST cheat sheet documentation #637 (@najuzilu)
- TST: [pdflatex] Add build of quantecon-mini-example as a project style test case #636 (@mmcky)
- TST: Fix test_pdf failure. #633 (@rossbar)
- Minor update for the extra-navbar section in advanced.md #631 (@malvikasharan)
- TST: update testing requirements and adjust ignore #626 (@mmcky)
- bump peaceiris/actions-gh-pages to v3.6.1 #625 (@peaceiris)
- documenting directive keywords better #623 (@choldgraf)
- clarifying config values #622 (@choldgraf)
- add tex macro documentation #618 (@najuzilu)
- fixing docs bug in template #617 (@choldgraf)
- FIX: fix bug when latex config not specified in project for "latex_documents" #614 (@mmcky)
- adding extra footer docs #611 (@choldgraf)
- nesting notes #599 (@choldgraf)
- docs update #597 (@choldgraf)
- updating docs and fixing single page bug #592 (@choldgraf)
- add html section to tip about navbar_number_sections #590 (@amueller)
- adding custom css and js and updating docs #583 (@choldgraf)
- Devdocs #581 (@choldgraf)
- [DOC] fix contrib link in readme #577 (@amueller)
- Document use of pure html #576 (@joergbrech)
- add no_title argument to toc #571 (@amueller)
- instructions for toggle and toc docs #570 (@choldgraf)
- DOC: A few documentation fix-ups #569 (@rossbar)
- add ticks to execute_notebooks: off in docs #568 (@amueller)
- fixing flake #567 (@choldgraf)
- fix typo #565 (@amueller)
- add build to test_clean method prior to build --builder pdflatex #561 (@najuzilu)
- update vscode myst markdown extension url #559 (@najuzilu)
- [BUG] Added a returncode for make all-pdf #556 (@AakashGfude)
- [ENH] A simple {tableofcontents} directive #553 (@AakashGfude)
- clarifying qe mini example #550 (@choldgraf)
- Small edits to intro page on docs. #548 (@jstac)
- updating intro page and other docs #545 (@choldgraf)
- Update default_config.yml #544 (@Cyb3rWard0g)
- Fix broken references in docs #541 (@consideRatio)
- Corrects info on bibliography in separate file #537 (@kyleniemeyer)
- explicitly giving jupyter book install version #535 (@choldgraf)
- Add modules needed to build the example book to the instructions. #533 (@jpivarski)
- citations clean up #529 (@choldgraf)
- updating documentation #527 (@choldgraf)
- adding tests for TOC cases #525 (@choldgraf)
- adding linkcheck docs and support #524 (@choldgraf)
- update latexpdf to pdflatex in the documentation #523 (@najuzilu)
- update jb contributor link #522 (@najuzilu)
- Additional clean options #521 (@najuzilu)
- updating deploy docs #520 ([@choldgraf](https:...
v0.7.0b4
v0.7.0b2
v0.7.0b1
v0.7.0b0
v0.6.5 final legacy release
This is the final Jupyter Book "legacy" release. The next release (v0.7.0) will be a total re-write.
v0.6.4...v0.6.5
Merged PRs
- adding a gallery #472 (@choldgraf)
- [ENH] Raise error if page URL does not start with os.sep #471 (@brian-rose)
- Display the Jupyter Book icon on pypi #470 (@mwouts)
- [DOC] changed circleci docs to reflect consistent job name #463 (@alexnakagawa)
- Fix links to book-html and github-pages #457 (@mwouts)
- Intronetlify #454 (@choldgraf)
- [DOC] Minor changes to documentation #452 (@rossbar)
Contributors to this release
(GitHub contributors page for this release)
@akhmerov | @alexnakagawa | @brian-rose | @choldgraf | @chrisjsewell | @emdupre | @joergbrech | @matteoacrossi | @mgeier | @mwouts | @phaustin | @rossbar
v0.6.4
v0.6.3...v0.6.4
Enhancements made
- improving the upgrade functionality #449 (@choldgraf)
- scrolling outputs #444 (@choldgraf)
- adding a page for math instructions #432 (@choldgraf)
- updating thebelab and improving code highlighting #422 (@choldgraf)
- Hide outputs and markdown cells #420 (@choldgraf)
- Adding a "test" section for pages that are hard to test w/ python #416 (@choldgraf)
- refactoring sidebar highlighting and allowing collapsed subsections #412 (@choldgraf)
- adding ability to add authors and titles #390 (@choldgraf)
- improving search functionality #374 (@choldgraf)
- Add kernel path for thebelab #189 (@joergbrech)
Bugs fixed
- Add installation module and fix circle #450 (@choldgraf)
- fixing thebelab highlighting #446 (@choldgraf)
- fixing full width content and some formatting bugs #417 (@choldgraf)
- [FIX] Fix for on-page anchor-based TOC issues #414 (@GasperPaul)
- tocfix #406 (@choldgraf)
- fixing toc #405 (@choldgraf)
- [FIX] Fixed issue with Unicode characters in TOC #400 (@GasperPaul)
- [FIX] Fix for path separator issue on Windows #398 (@GasperPaul)
- fixing issue template #393 (@choldgraf)
Other merged PRs
- moving thebelab config to within the page instead of head #448 (@choldgraf)
- only show TOC if there are headers for it #441 (@choldgraf)
- Update README.md #425 (@choldgraf)
- using thebelab latest #423 (@choldgraf)
- Update limits.md #415 (@choldgraf)
- moving some modules to pathlib #403 (@choldgraf)
- adding code structure and moving contributing guide #394 (@choldgraf)
- updating getting started guide #392 (@choldgraf)
- version bump #389 (@choldgraf)
- new release and updating instructions #387 (@choldgraf)
Contributors to this release
(GitHub contributors page for this release)
@choldgraf | @emdupre | @GasperPaul | @javag97 | @joergbrech | @melaniewalsh | @psychemedia
v0.6.3
v0.6.3
This is a minor release with several stability and convenience improvements since the
large refactoring that happened in v0.6.0. It adds a few new layout elements, the ability
to pre-initialize cells when starting thebelab, and adds configuration and
documentation for deploying your book on Netlify.
Enhancements made
- adding anchors above headers #366 (@choldgraf)
- adding CSS rules for epigraphs #365 (@choldgraf)
- netlify config #359 (@choldgraf)
- Thebelab init #352 (@choldgraf)
- [WIP] Add option to clear outputs in build command #349 (@akhilputhiry)
- [ENH] Netlify Continuous Deployment #342 (@emdupre)
Bugs fixed
- css for thebelab z-order #386 (@choldgraf)
- fixing TOC auto gen bug #375 (@choldgraf)
- fixing page path link #368 (@choldgraf)
- fixing interact link bug #367 (@choldgraf)
- Update required python version #363 (@emdupre)
- fix: fuzzy matching of jupyter book versions #346 (@emdupre)
- fixing scrolling #336 (@choldgraf)
Maintenance and upkeep improvements
- fixing load ntbk function #385 (@choldgraf)
- load ntbk function #384 (@choldgraf)
- moving CSS and JS generation to their own function #381 (@choldgraf)
- making sure gemfile.lock is removed #379 (@choldgraf)
- removing unnecessary requirements #378 (@choldgraf)
- making toc gen sorted #377 (@choldgraf)
- fixing up download functionality #373 (@choldgraf)
- small refactoring of names and layout #372 (@choldgraf)
- Bump rubyzip from 1.2.4 to 2.0.0 in /jupyter_book/book_template #371 (@dependabot)
- moving to jupyterbook.org #370 (@choldgraf)
- inlining svgs and small tweaks #369 (@choldgraf)
- [fix] update docker image and documentation #364 (@emdupre)
- moving js outside of _includes if not needed #347 (@choldgraf)
- removing unnecessary clean_lines function #345 (@choldgraf)
- modularizing the bage building and beefing up single page building #344 (@choldgraf)
Documentation improvements
- DOC: intro.md: Jupyter Books -> Jupyter Book #383 (@westurner)
Other merged PRs
- Update executing.ipynb #350 (@psychemedia)
- adding better circle instructions #341 (@choldgraf)
- cleaning up circle #340 (@choldgraf)
- ghp-import in circle #339 (@choldgraf)
- removing _build artifacts #338 (@choldgraf)
- making some files optional in upgrade #337 (@choldgraf)
- adding google analytics info #335 (@choldgraf)
- updating changelog #334 (@choldgraf)
- fixing releases info #333 (@choldgraf)
Contributors for this release (commentors + issue/PR authors)
GitHub contributors page for this release
@akhilputhiry | @catafest | @choldgraf | @chrispyles | @dependabot | @emdupre | @emile-igarape | @fmaussion | @jasmainak | @jobindj | @krinsman | @LY1806620741 | @mwcraig | @ocefpaf | @oscarys | @psychemedia | @SamLau95 | @sidneymbell | @sodre | @taylorgibson | @westurner
v0.6.0
v0.6.0 (2019-09-17)
Major changes
This version of Jupyter Book contains several major enhancements to the book's
build process and layout. Here as some major highlights:
Page build process
When you run jupyter-book build, your pages will now be converted into HTML
instead of Jekyll Markdown. This uses nbconvert under the hood, and should make
behavior more consistent (and less-dependent on Jekyll's specific markdown flavor, Kramdown).
This will also make it easier to build individual page HTML without requiring a full book.
Page layout enhancements.
There are a number of enhancements to the layout of each page of the book.
The topbar is now sticky, and uses whitespace more effectively. In addition, the
right TOC will now only show up when the page is wide enough, and let the user
hover over it to see the page's TOC content on narrower screens.
Jupytext integration
✨✨experimental✨✨
Jupyter Book can now build page HTML from Jupytext text files. This allows
you to store your book content in plain text and convert into Jupyter Notebooks
and page HTML at build time. See the documentation on using jupytext
for more information.
PDF downloads
There's now a button that uses PrintJS to download a PDF version of each
page of your book. This will let readers download content offline and
read on their own.
TOC auto-generation
We've improved the auto-generation of the Table of Contents for a folder
of book content. This should make it easier to quickly get started
generating a TOC file for your Jupyter Book.
Popouts and full-width cells
There are now two different kinds of cell layouts. popouts will
be placed to the right of your book content. This allows you to call out
information without disrupting the narrative flow of your page. full-width
cells will take up a larger width on the page, causing the reader to focus on
this information. This makes it easier to highlight wide-form visual content.
Here are a few examples of this, you can find out more on the layouts documentation
Footers
You can now add a configurable footer to each page of your book! You can
do so from the footer_text field in the config.yml file for your book.
PRs and Issues
Implemented enhancements:
- Improve the auto-TOC function #271
- Export pages to PDF #267
- Adding popouts to the right #266
- Add option to execute notebooks when building the book #234
- Add a footer for each page #233
- adding error message context to the build CLI command #320 (choldgraf)
- Wrap
jekyll-rawcells with {% raw %} #308 (SamLau95) - adding popout cell #302 (choldgraf)
- adding right toc showing when there's no sidebar content #300 (choldgraf)
- adding jupytext support #280 (choldgraf)
- adding print button #279 (choldgraf)
- Updating page layout and hoverable table of contents #278 (choldgraf)
- Add a hiding topbar w/ scroll #276 (choldgraf)
- Improving TOC functionality #273 (choldgraf)
- use celltagpreprocessor to remove parts of cells and updating running code module #264 (choldgraf)
- Create footer #254 (martinagvilas)
- removing jekyll markdown templates #249 (choldgraf)
- adding simple page building #248 (choldgraf)
- HTML build step #239 (choldgraf)
- [WIP] Refactoring page layout + adding popouts and a topbar #169 (choldgraf)
Fixed bugs:
- Some small formatting issues following upgrade to master #296
- Make the PDF print work for MathJax math #285
- Code cells in plain Markdown files are rendered as raw text #283
- 'jupyter-book upgrade' deletes new references #261
- default book doesn't build properly on github - symlink error #237
- Double check installation dependencies #211
- Don't use quotes for user-entered YAML entries #305 (SamLau95)
- Set a blank excerpt for all pages #303 (SamLau95)
- fixing footer width #301 (choldgraf)
- Use CDNs for JS libraries #292 (SamLau95)
- Load thebelab asynchronously #291 (SamLau95)
- Fix missing </div> if page.interact_link is false #290 (SamLau95)
- fixing jupytext markdown inconsistencies #288 (choldgraf)
- fixing double math printing #286 (choldgraf)
- fixing up print functionality #284 (choldgraf)
- making a download PDF button appear on all pages #282 (choldgraf)
- fixing the TOC function #270 (choldgraf)
- [FIX] Fix references being deleted with jupyter-upgrade #263 (martinagvilas)
- fixing links #260 (choldgraf)
- adding instructions for build #257 (choldgraf)
- fixing pypi description #256 (choldgraf)
- version fix #250 (choldgraf)
Closed issues:
- Jupyter Notebook can't close a running notebook #317
- Building book fails with a jinja2.exceptions.TemplateNotFound error #310
- serving non- md/ipynb content #295
- Broken links #259
- Missing file error #253
- Multicursor sometimes only deletes one line when there's spaces #251
- Release summary for v0.6 #331
Merged pull requests: