diff --git a/CHANGELOG.md b/CHANGELOG.md index b52410ddfb321d5a2ad0a786563aadd66a4d71ab..2f31ebff59d69f5752b30732541b60f513009fe8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,417 +1,417 @@ # Change Log # v0.6.3...v0.6.4 -([full changelog](https://github.com/jupyter/jupyter-book/compare/v0.6.3...v0.6.4)) +([full changelog](https://github.com/ExecutableBookProject/jupyter-book/compare/v0.6.3...v0.6.4)) ## Enhancements made -* improving the upgrade functionality [#449](https://github.com/jupyter/jupyter-book/pull/449) ([@choldgraf](https://github.com/choldgraf)) -* scrolling outputs [#444](https://github.com/jupyter/jupyter-book/pull/444) ([@choldgraf](https://github.com/choldgraf)) -* adding a page for math instructions [#432](https://github.com/jupyter/jupyter-book/pull/432) ([@choldgraf](https://github.com/choldgraf)) -* updating thebelab and improving code highlighting [#422](https://github.com/jupyter/jupyter-book/pull/422) ([@choldgraf](https://github.com/choldgraf)) -* Hide outputs and markdown cells [#420](https://github.com/jupyter/jupyter-book/pull/420) ([@choldgraf](https://github.com/choldgraf)) -* Adding a "test" section for pages that are hard to test w/ python [#416](https://github.com/jupyter/jupyter-book/pull/416) ([@choldgraf](https://github.com/choldgraf)) -* refactoring sidebar highlighting and allowing collapsed subsections [#412](https://github.com/jupyter/jupyter-book/pull/412) ([@choldgraf](https://github.com/choldgraf)) -* adding ability to add authors and titles [#390](https://github.com/jupyter/jupyter-book/pull/390) ([@choldgraf](https://github.com/choldgraf)) -* improving search functionality [#374](https://github.com/jupyter/jupyter-book/pull/374) ([@choldgraf](https://github.com/choldgraf)) -* Add kernel path for thebelab [#189](https://github.com/jupyter/jupyter-book/pull/189) ([@joergbrech](https://github.com/joergbrech)) +* improving the upgrade functionality [#449](https://github.com/ExecutableBookProject/jupyter-book/pull/449) ([@choldgraf](https://github.com/choldgraf)) +* scrolling outputs [#444](https://github.com/ExecutableBookProject/jupyter-book/pull/444) ([@choldgraf](https://github.com/choldgraf)) +* adding a page for math instructions [#432](https://github.com/ExecutableBookProject/jupyter-book/pull/432) ([@choldgraf](https://github.com/choldgraf)) +* updating thebelab and improving code highlighting [#422](https://github.com/ExecutableBookProject/jupyter-book/pull/422) ([@choldgraf](https://github.com/choldgraf)) +* Hide outputs and markdown cells [#420](https://github.com/ExecutableBookProject/jupyter-book/pull/420) ([@choldgraf](https://github.com/choldgraf)) +* Adding a "test" section for pages that are hard to test w/ python [#416](https://github.com/ExecutableBookProject/jupyter-book/pull/416) ([@choldgraf](https://github.com/choldgraf)) +* refactoring sidebar highlighting and allowing collapsed subsections [#412](https://github.com/ExecutableBookProject/jupyter-book/pull/412) ([@choldgraf](https://github.com/choldgraf)) +* adding ability to add authors and titles [#390](https://github.com/ExecutableBookProject/jupyter-book/pull/390) ([@choldgraf](https://github.com/choldgraf)) +* improving search functionality [#374](https://github.com/ExecutableBookProject/jupyter-book/pull/374) ([@choldgraf](https://github.com/choldgraf)) +* Add kernel path for thebelab [#189](https://github.com/ExecutableBookProject/jupyter-book/pull/189) ([@joergbrech](https://github.com/joergbrech)) ## Bugs fixed -* Add installation module and fix circle [#450](https://github.com/jupyter/jupyter-book/pull/450) ([@choldgraf](https://github.com/choldgraf)) -* fixing thebelab highlighting [#446](https://github.com/jupyter/jupyter-book/pull/446) ([@choldgraf](https://github.com/choldgraf)) -* fixing full width content and some formatting bugs [#417](https://github.com/jupyter/jupyter-book/pull/417) ([@choldgraf](https://github.com/choldgraf)) -* [FIX] Fix for on-page anchor-based TOC issues [#414](https://github.com/jupyter/jupyter-book/pull/414) ([@GasperPaul](https://github.com/GasperPaul)) -* tocfix [#406](https://github.com/jupyter/jupyter-book/pull/406) ([@choldgraf](https://github.com/choldgraf)) -* fixing toc [#405](https://github.com/jupyter/jupyter-book/pull/405) ([@choldgraf](https://github.com/choldgraf)) -* [FIX] Fixed issue with Unicode characters in TOC [#400](https://github.com/jupyter/jupyter-book/pull/400) ([@GasperPaul](https://github.com/GasperPaul)) -* [FIX] Fix for path separator issue on Windows [#398](https://github.com/jupyter/jupyter-book/pull/398) ([@GasperPaul](https://github.com/GasperPaul)) -* fixing issue template [#393](https://github.com/jupyter/jupyter-book/pull/393) ([@choldgraf](https://github.com/choldgraf)) +* Add installation module and fix circle [#450](https://github.com/ExecutableBookProject/jupyter-book/pull/450) ([@choldgraf](https://github.com/choldgraf)) +* fixing thebelab highlighting [#446](https://github.com/ExecutableBookProject/jupyter-book/pull/446) ([@choldgraf](https://github.com/choldgraf)) +* fixing full width content and some formatting bugs [#417](https://github.com/ExecutableBookProject/jupyter-book/pull/417) ([@choldgraf](https://github.com/choldgraf)) +* [FIX] Fix for on-page anchor-based TOC issues [#414](https://github.com/ExecutableBookProject/jupyter-book/pull/414) ([@GasperPaul](https://github.com/GasperPaul)) +* tocfix [#406](https://github.com/ExecutableBookProject/jupyter-book/pull/406) ([@choldgraf](https://github.com/choldgraf)) +* fixing toc [#405](https://github.com/ExecutableBookProject/jupyter-book/pull/405) ([@choldgraf](https://github.com/choldgraf)) +* [FIX] Fixed issue with Unicode characters in TOC [#400](https://github.com/ExecutableBookProject/jupyter-book/pull/400) ([@GasperPaul](https://github.com/GasperPaul)) +* [FIX] Fix for path separator issue on Windows [#398](https://github.com/ExecutableBookProject/jupyter-book/pull/398) ([@GasperPaul](https://github.com/GasperPaul)) +* fixing issue template [#393](https://github.com/ExecutableBookProject/jupyter-book/pull/393) ([@choldgraf](https://github.com/choldgraf)) ## Other merged PRs -* moving thebelab config to within the page instead of head [#448](https://github.com/jupyter/jupyter-book/pull/448) ([@choldgraf](https://github.com/choldgraf)) -* only show TOC if there are headers for it [#441](https://github.com/jupyter/jupyter-book/pull/441) ([@choldgraf](https://github.com/choldgraf)) -* Update README.md [#425](https://github.com/jupyter/jupyter-book/pull/425) ([@choldgraf](https://github.com/choldgraf)) -* using thebelab latest [#423](https://github.com/jupyter/jupyter-book/pull/423) ([@choldgraf](https://github.com/choldgraf)) -* Update limits.md [#415](https://github.com/jupyter/jupyter-book/pull/415) ([@choldgraf](https://github.com/choldgraf)) -* moving some modules to pathlib [#403](https://github.com/jupyter/jupyter-book/pull/403) ([@choldgraf](https://github.com/choldgraf)) -* adding code structure and moving contributing guide [#394](https://github.com/jupyter/jupyter-book/pull/394) ([@choldgraf](https://github.com/choldgraf)) -* updating getting started guide [#392](https://github.com/jupyter/jupyter-book/pull/392) ([@choldgraf](https://github.com/choldgraf)) -* version bump [#389](https://github.com/jupyter/jupyter-book/pull/389) ([@choldgraf](https://github.com/choldgraf)) -* new release and updating instructions [#387](https://github.com/jupyter/jupyter-book/pull/387) ([@choldgraf](https://github.com/choldgraf)) +* moving thebelab config to within the page instead of head [#448](https://github.com/ExecutableBookProject/jupyter-book/pull/448) ([@choldgraf](https://github.com/choldgraf)) +* only show TOC if there are headers for it [#441](https://github.com/ExecutableBookProject/jupyter-book/pull/441) ([@choldgraf](https://github.com/choldgraf)) +* Update README.md [#425](https://github.com/ExecutableBookProject/jupyter-book/pull/425) ([@choldgraf](https://github.com/choldgraf)) +* using thebelab latest [#423](https://github.com/ExecutableBookProject/jupyter-book/pull/423) ([@choldgraf](https://github.com/choldgraf)) +* Update limits.md [#415](https://github.com/ExecutableBookProject/jupyter-book/pull/415) ([@choldgraf](https://github.com/choldgraf)) +* moving some modules to pathlib [#403](https://github.com/ExecutableBookProject/jupyter-book/pull/403) ([@choldgraf](https://github.com/choldgraf)) +* adding code structure and moving contributing guide [#394](https://github.com/ExecutableBookProject/jupyter-book/pull/394) ([@choldgraf](https://github.com/choldgraf)) +* updating getting started guide [#392](https://github.com/ExecutableBookProject/jupyter-book/pull/392) ([@choldgraf](https://github.com/choldgraf)) +* version bump [#389](https://github.com/ExecutableBookProject/jupyter-book/pull/389) ([@choldgraf](https://github.com/choldgraf)) +* new release and updating instructions [#387](https://github.com/ExecutableBookProject/jupyter-book/pull/387) ([@choldgraf](https://github.com/choldgraf)) ## Contributors to this release -([GitHub contributors page for this release](https://github.com/jupyter/jupyter-book/graphs/contributors?from=2019-10-07&to=2019-12-06&type=c)) +([GitHub contributors page for this release](https://github.com/ExecutableBookProject/jupyter-book/graphs/contributors?from=2019-10-07&to=2019-12-06&type=c)) [@choldgraf](https://github.com/search?q=repo%3Ajupyter%2Fjupyter-book+involves%3Acholdgraf+updated%3A2019-10-07..2019-12-06&type=Issues) | [@emdupre](https://github.com/search?q=repo%3Ajupyter%2Fjupyter-book+involves%3Aemdupre+updated%3A2019-10-07..2019-12-06&type=Issues) | [@GasperPaul](https://github.com/search?q=repo%3Ajupyter%2Fjupyter-book+involves%3AGasperPaul+updated%3A2019-10-07..2019-12-06&type=Issues) | [@javag97](https://github.com/search?q=repo%3Ajupyter%2Fjupyter-book+involves%3Ajavag97+updated%3A2019-10-07..2019-12-06&type=Issues) | [@joergbrech](https://github.com/search?q=repo%3Ajupyter%2Fjupyter-book+involves%3Ajoergbrech+updated%3A2019-10-07..2019-12-06&type=Issues) | [@melaniewalsh](https://github.com/search?q=repo%3Ajupyter%2Fjupyter-book+involves%3Amelaniewalsh+updated%3A2019-10-07..2019-12-06&type=Issues) | [@psychemedia](https://github.com/search?q=repo%3Ajupyter%2Fjupyter-book+involves%3Apsychemedia+updated%3A2019-10-07..2019-12-06&type=Issues) # v0.6.0...v0.6.3 -([full changelog](https://github.com/jupyter/jupyter-book/compare/v0.6.0...v0.6.3)) +([full changelog](https://github.com/ExecutableBookProject/jupyter-book/compare/v0.6.0...v0.6.3)) ## Enhancements made -* adding anchors above headers [#366](https://github.com/jupyter/jupyter-book/pull/366) ([@choldgraf](https://github.com/choldgraf)) -* adding CSS rules for epigraphs [#365](https://github.com/jupyter/jupyter-book/pull/365) ([@choldgraf](https://github.com/choldgraf)) -* netlify config [#359](https://github.com/jupyter/jupyter-book/pull/359) ([@choldgraf](https://github.com/choldgraf)) -* Thebelab init [#352](https://github.com/jupyter/jupyter-book/pull/352) ([@choldgraf](https://github.com/choldgraf)) -* [WIP] Add option to clear outputs in build command [#349](https://github.com/jupyter/jupyter-book/pull/349) ([@akhilputhiry](https://github.com/akhilputhiry)) -* [ENH] Netlify Continuous Deployment [#342](https://github.com/jupyter/jupyter-book/pull/342) ([@emdupre](https://github.com/emdupre)) +* adding anchors above headers [#366](https://github.com/ExecutableBookProject/jupyter-book/pull/366) ([@choldgraf](https://github.com/choldgraf)) +* adding CSS rules for epigraphs [#365](https://github.com/ExecutableBookProject/jupyter-book/pull/365) ([@choldgraf](https://github.com/choldgraf)) +* netlify config [#359](https://github.com/ExecutableBookProject/jupyter-book/pull/359) ([@choldgraf](https://github.com/choldgraf)) +* Thebelab init [#352](https://github.com/ExecutableBookProject/jupyter-book/pull/352) ([@choldgraf](https://github.com/choldgraf)) +* [WIP] Add option to clear outputs in build command [#349](https://github.com/ExecutableBookProject/jupyter-book/pull/349) ([@akhilputhiry](https://github.com/akhilputhiry)) +* [ENH] Netlify Continuous Deployment [#342](https://github.com/ExecutableBookProject/jupyter-book/pull/342) ([@emdupre](https://github.com/emdupre)) ## Bugs fixed -* css for thebelab z-order [#386](https://github.com/jupyter/jupyter-book/pull/386) ([@choldgraf](https://github.com/choldgraf)) -* fixing TOC auto gen bug [#375](https://github.com/jupyter/jupyter-book/pull/375) ([@choldgraf](https://github.com/choldgraf)) -* fixing page path link [#368](https://github.com/jupyter/jupyter-book/pull/368) ([@choldgraf](https://github.com/choldgraf)) -* fixing interact link bug [#367](https://github.com/jupyter/jupyter-book/pull/367) ([@choldgraf](https://github.com/choldgraf)) -* Update required python version [#363](https://github.com/jupyter/jupyter-book/pull/363) ([@emdupre](https://github.com/emdupre)) -* fix: fuzzy matching of jupyter book versions [#346](https://github.com/jupyter/jupyter-book/pull/346) ([@emdupre](https://github.com/emdupre)) -* fixing scrolling [#336](https://github.com/jupyter/jupyter-book/pull/336) ([@choldgraf](https://github.com/choldgraf)) +* css for thebelab z-order [#386](https://github.com/ExecutableBookProject/jupyter-book/pull/386) ([@choldgraf](https://github.com/choldgraf)) +* fixing TOC auto gen bug [#375](https://github.com/ExecutableBookProject/jupyter-book/pull/375) ([@choldgraf](https://github.com/choldgraf)) +* fixing page path link [#368](https://github.com/ExecutableBookProject/jupyter-book/pull/368) ([@choldgraf](https://github.com/choldgraf)) +* fixing interact link bug [#367](https://github.com/ExecutableBookProject/jupyter-book/pull/367) ([@choldgraf](https://github.com/choldgraf)) +* Update required python version [#363](https://github.com/ExecutableBookProject/jupyter-book/pull/363) ([@emdupre](https://github.com/emdupre)) +* fix: fuzzy matching of jupyter book versions [#346](https://github.com/ExecutableBookProject/jupyter-book/pull/346) ([@emdupre](https://github.com/emdupre)) +* fixing scrolling [#336](https://github.com/ExecutableBookProject/jupyter-book/pull/336) ([@choldgraf](https://github.com/choldgraf)) ## Maintenance and upkeep improvements -* fixing load ntbk function [#385](https://github.com/jupyter/jupyter-book/pull/385) ([@choldgraf](https://github.com/choldgraf)) -* load ntbk function [#384](https://github.com/jupyter/jupyter-book/pull/384) ([@choldgraf](https://github.com/choldgraf)) -* moving CSS and JS generation to their own function [#381](https://github.com/jupyter/jupyter-book/pull/381) ([@choldgraf](https://github.com/choldgraf)) -* making sure gemfile.lock is removed [#379](https://github.com/jupyter/jupyter-book/pull/379) ([@choldgraf](https://github.com/choldgraf)) -* removing unnecessary requirements [#378](https://github.com/jupyter/jupyter-book/pull/378) ([@choldgraf](https://github.com/choldgraf)) -* making toc gen sorted [#377](https://github.com/jupyter/jupyter-book/pull/377) ([@choldgraf](https://github.com/choldgraf)) -* fixing up download functionality [#373](https://github.com/jupyter/jupyter-book/pull/373) ([@choldgraf](https://github.com/choldgraf)) -* small refactoring of names and layout [#372](https://github.com/jupyter/jupyter-book/pull/372) ([@choldgraf](https://github.com/choldgraf)) -* Bump rubyzip from 1.2.4 to 2.0.0 in /jupyter_book/book_template [#371](https://github.com/jupyter/jupyter-book/pull/371) ([@dependabot](https://github.com/dependabot)) -* moving to jupyterbook.org [#370](https://github.com/jupyter/jupyter-book/pull/370) ([@choldgraf](https://github.com/choldgraf)) -* inlining svgs and small tweaks [#369](https://github.com/jupyter/jupyter-book/pull/369) ([@choldgraf](https://github.com/choldgraf)) -* [fix] update docker image and documentation [#364](https://github.com/jupyter/jupyter-book/pull/364) ([@emdupre](https://github.com/emdupre)) -* moving js outside of _includes if not needed [#347](https://github.com/jupyter/jupyter-book/pull/347) ([@choldgraf](https://github.com/choldgraf)) -* removing unnecessary clean_lines function [#345](https://github.com/jupyter/jupyter-book/pull/345) ([@choldgraf](https://github.com/choldgraf)) -* modularizing the bage building and beefing up single page building [#344](https://github.com/jupyter/jupyter-book/pull/344) ([@choldgraf](https://github.com/choldgraf)) +* fixing load ntbk function [#385](https://github.com/ExecutableBookProject/jupyter-book/pull/385) ([@choldgraf](https://github.com/choldgraf)) +* load ntbk function [#384](https://github.com/ExecutableBookProject/jupyter-book/pull/384) ([@choldgraf](https://github.com/choldgraf)) +* moving CSS and JS generation to their own function [#381](https://github.com/ExecutableBookProject/jupyter-book/pull/381) ([@choldgraf](https://github.com/choldgraf)) +* making sure gemfile.lock is removed [#379](https://github.com/ExecutableBookProject/jupyter-book/pull/379) ([@choldgraf](https://github.com/choldgraf)) +* removing unnecessary requirements [#378](https://github.com/ExecutableBookProject/jupyter-book/pull/378) ([@choldgraf](https://github.com/choldgraf)) +* making toc gen sorted [#377](https://github.com/ExecutableBookProject/jupyter-book/pull/377) ([@choldgraf](https://github.com/choldgraf)) +* fixing up download functionality [#373](https://github.com/ExecutableBookProject/jupyter-book/pull/373) ([@choldgraf](https://github.com/choldgraf)) +* small refactoring of names and layout [#372](https://github.com/ExecutableBookProject/jupyter-book/pull/372) ([@choldgraf](https://github.com/choldgraf)) +* Bump rubyzip from 1.2.4 to 2.0.0 in /jupyter_book/book_template [#371](https://github.com/ExecutableBookProject/jupyter-book/pull/371) ([@dependabot](https://github.com/dependabot)) +* moving to jupyterbook.org [#370](https://github.com/ExecutableBookProject/jupyter-book/pull/370) ([@choldgraf](https://github.com/choldgraf)) +* inlining svgs and small tweaks [#369](https://github.com/ExecutableBookProject/jupyter-book/pull/369) ([@choldgraf](https://github.com/choldgraf)) +* [fix] update docker image and documentation [#364](https://github.com/ExecutableBookProject/jupyter-book/pull/364) ([@emdupre](https://github.com/emdupre)) +* moving js outside of _includes if not needed [#347](https://github.com/ExecutableBookProject/jupyter-book/pull/347) ([@choldgraf](https://github.com/choldgraf)) +* removing unnecessary clean_lines function [#345](https://github.com/ExecutableBookProject/jupyter-book/pull/345) ([@choldgraf](https://github.com/choldgraf)) +* modularizing the bage building and beefing up single page building [#344](https://github.com/ExecutableBookProject/jupyter-book/pull/344) ([@choldgraf](https://github.com/choldgraf)) ## Documentation improvements -* DOC: intro.md: Jupyter Books -> Jupyter Book [#383](https://github.com/jupyter/jupyter-book/pull/383) ([@westurner](https://github.com/westurner)) +* DOC: intro.md: Jupyter Books -> Jupyter Book [#383](https://github.com/ExecutableBookProject/jupyter-book/pull/383) ([@westurner](https://github.com/westurner)) ## Other merged PRs -* Update executing.ipynb [#350](https://github.com/jupyter/jupyter-book/pull/350) ([@psychemedia](https://github.com/psychemedia)) -* adding better circle instructions [#341](https://github.com/jupyter/jupyter-book/pull/341) ([@choldgraf](https://github.com/choldgraf)) -* cleaning up circle [#340](https://github.com/jupyter/jupyter-book/pull/340) ([@choldgraf](https://github.com/choldgraf)) -* ghp-import in circle [#339](https://github.com/jupyter/jupyter-book/pull/339) ([@choldgraf](https://github.com/choldgraf)) -* removing _build artifacts [#338](https://github.com/jupyter/jupyter-book/pull/338) ([@choldgraf](https://github.com/choldgraf)) -* making some files optional in upgrade [#337](https://github.com/jupyter/jupyter-book/pull/337) ([@choldgraf](https://github.com/choldgraf)) -* adding google analytics info [#335](https://github.com/jupyter/jupyter-book/pull/335) ([@choldgraf](https://github.com/choldgraf)) -* updating changelog [#334](https://github.com/jupyter/jupyter-book/pull/334) ([@choldgraf](https://github.com/choldgraf)) -* fixing releases info [#333](https://github.com/jupyter/jupyter-book/pull/333) ([@choldgraf](https://github.com/choldgraf)) - -# [v0.6.0](https://github.com/jupyter/jupyter-book/tree/v0.6.0) (2019-09-17) -[Full Changelog](https://github.com/jupyter/jupyter-book/compare/v0.5.2...v0.6.0) +* Update executing.ipynb [#350](https://github.com/ExecutableBookProject/jupyter-book/pull/350) ([@psychemedia](https://github.com/psychemedia)) +* adding better circle instructions [#341](https://github.com/ExecutableBookProject/jupyter-book/pull/341) ([@choldgraf](https://github.com/choldgraf)) +* cleaning up circle [#340](https://github.com/ExecutableBookProject/jupyter-book/pull/340) ([@choldgraf](https://github.com/choldgraf)) +* ghp-import in circle [#339](https://github.com/ExecutableBookProject/jupyter-book/pull/339) ([@choldgraf](https://github.com/choldgraf)) +* removing _build artifacts [#338](https://github.com/ExecutableBookProject/jupyter-book/pull/338) ([@choldgraf](https://github.com/choldgraf)) +* making some files optional in upgrade [#337](https://github.com/ExecutableBookProject/jupyter-book/pull/337) ([@choldgraf](https://github.com/choldgraf)) +* adding google analytics info [#335](https://github.com/ExecutableBookProject/jupyter-book/pull/335) ([@choldgraf](https://github.com/choldgraf)) +* updating changelog [#334](https://github.com/ExecutableBookProject/jupyter-book/pull/334) ([@choldgraf](https://github.com/choldgraf)) +* fixing releases info [#333](https://github.com/ExecutableBookProject/jupyter-book/pull/333) ([@choldgraf](https://github.com/choldgraf)) + +# [v0.6.0](https://github.com/ExecutableBookProject/jupyter-book/tree/v0.6.0) (2019-09-17) +[Full Changelog](https://github.com/ExecutableBookProject/jupyter-book/compare/v0.5.2...v0.6.0) **Implemented enhancements:** -- Improve the auto-TOC function [\#271](https://github.com/jupyter/jupyter-book/issues/271) -- Export pages to PDF [\#267](https://github.com/jupyter/jupyter-book/issues/267) -- Adding popouts to the right [\#266](https://github.com/jupyter/jupyter-book/issues/266) -- Add option to execute notebooks when building the book [\#234](https://github.com/jupyter/jupyter-book/issues/234) -- Add a footer for each page [\#233](https://github.com/jupyter/jupyter-book/issues/233) -- adding error message context to the build CLI command [\#320](https://github.com/jupyter/jupyter-book/pull/320) ([choldgraf](https://github.com/choldgraf)) -- Wrap `jekyll-raw` cells with {% raw %} [\#308](https://github.com/jupyter/jupyter-book/pull/308) ([SamLau95](https://github.com/SamLau95)) -- adding popout cell [\#302](https://github.com/jupyter/jupyter-book/pull/302) ([choldgraf](https://github.com/choldgraf)) -- adding right toc showing when there's no sidebar content [\#300](https://github.com/jupyter/jupyter-book/pull/300) ([choldgraf](https://github.com/choldgraf)) -- adding jupytext support [\#280](https://github.com/jupyter/jupyter-book/pull/280) ([choldgraf](https://github.com/choldgraf)) -- adding print button [\#279](https://github.com/jupyter/jupyter-book/pull/279) ([choldgraf](https://github.com/choldgraf)) -- Updating page layout and hoverable table of contents [\#278](https://github.com/jupyter/jupyter-book/pull/278) ([choldgraf](https://github.com/choldgraf)) -- Add a hiding topbar w/ scroll [\#276](https://github.com/jupyter/jupyter-book/pull/276) ([choldgraf](https://github.com/choldgraf)) -- Improving TOC functionality [\#273](https://github.com/jupyter/jupyter-book/pull/273) ([choldgraf](https://github.com/choldgraf)) -- use celltagpreprocessor to remove parts of cells and updating running code module [\#264](https://github.com/jupyter/jupyter-book/pull/264) ([choldgraf](https://github.com/choldgraf)) -- Create footer [\#254](https://github.com/jupyter/jupyter-book/pull/254) ([martinagvilas](https://github.com/martinagvilas)) -- removing jekyll markdown templates [\#249](https://github.com/jupyter/jupyter-book/pull/249) ([choldgraf](https://github.com/choldgraf)) -- adding simple page building [\#248](https://github.com/jupyter/jupyter-book/pull/248) ([choldgraf](https://github.com/choldgraf)) -- HTML build step [\#239](https://github.com/jupyter/jupyter-book/pull/239) ([choldgraf](https://github.com/choldgraf)) -- \[WIP\] Refactoring page layout + adding popouts and a topbar [\#169](https://github.com/jupyter/jupyter-book/pull/169) ([choldgraf](https://github.com/choldgraf)) +- Improve the auto-TOC function [\#271](https://github.com/ExecutableBookProject/jupyter-book/issues/271) +- Export pages to PDF [\#267](https://github.com/ExecutableBookProject/jupyter-book/issues/267) +- Adding popouts to the right [\#266](https://github.com/ExecutableBookProject/jupyter-book/issues/266) +- Add option to execute notebooks when building the book [\#234](https://github.com/ExecutableBookProject/jupyter-book/issues/234) +- Add a footer for each page [\#233](https://github.com/ExecutableBookProject/jupyter-book/issues/233) +- adding error message context to the build CLI command [\#320](https://github.com/ExecutableBookProject/jupyter-book/pull/320) ([choldgraf](https://github.com/choldgraf)) +- Wrap `jekyll-raw` cells with {% raw %} [\#308](https://github.com/ExecutableBookProject/jupyter-book/pull/308) ([SamLau95](https://github.com/SamLau95)) +- adding popout cell [\#302](https://github.com/ExecutableBookProject/jupyter-book/pull/302) ([choldgraf](https://github.com/choldgraf)) +- adding right toc showing when there's no sidebar content [\#300](https://github.com/ExecutableBookProject/jupyter-book/pull/300) ([choldgraf](https://github.com/choldgraf)) +- adding jupytext support [\#280](https://github.com/ExecutableBookProject/jupyter-book/pull/280) ([choldgraf](https://github.com/choldgraf)) +- adding print button [\#279](https://github.com/ExecutableBookProject/jupyter-book/pull/279) ([choldgraf](https://github.com/choldgraf)) +- Updating page layout and hoverable table of contents [\#278](https://github.com/ExecutableBookProject/jupyter-book/pull/278) ([choldgraf](https://github.com/choldgraf)) +- Add a hiding topbar w/ scroll [\#276](https://github.com/ExecutableBookProject/jupyter-book/pull/276) ([choldgraf](https://github.com/choldgraf)) +- Improving TOC functionality [\#273](https://github.com/ExecutableBookProject/jupyter-book/pull/273) ([choldgraf](https://github.com/choldgraf)) +- use celltagpreprocessor to remove parts of cells and updating running code module [\#264](https://github.com/ExecutableBookProject/jupyter-book/pull/264) ([choldgraf](https://github.com/choldgraf)) +- Create footer [\#254](https://github.com/ExecutableBookProject/jupyter-book/pull/254) ([martinagvilas](https://github.com/martinagvilas)) +- removing jekyll markdown templates [\#249](https://github.com/ExecutableBookProject/jupyter-book/pull/249) ([choldgraf](https://github.com/choldgraf)) +- adding simple page building [\#248](https://github.com/ExecutableBookProject/jupyter-book/pull/248) ([choldgraf](https://github.com/choldgraf)) +- HTML build step [\#239](https://github.com/ExecutableBookProject/jupyter-book/pull/239) ([choldgraf](https://github.com/choldgraf)) +- \[WIP\] Refactoring page layout + adding popouts and a topbar [\#169](https://github.com/ExecutableBookProject/jupyter-book/pull/169) ([choldgraf](https://github.com/choldgraf)) **Fixed bugs:** -- Some small formatting issues following upgrade to master [\#296](https://github.com/jupyter/jupyter-book/issues/296) -- Make the PDF print work for MathJax math [\#285](https://github.com/jupyter/jupyter-book/issues/285) -- Code cells in plain Markdown files are rendered as raw text [\#283](https://github.com/jupyter/jupyter-book/issues/283) -- 'jupyter-book upgrade' deletes new references [\#261](https://github.com/jupyter/jupyter-book/issues/261) -- default book doesn't build properly on github - symlink error [\#237](https://github.com/jupyter/jupyter-book/issues/237) -- Double check installation dependencies [\#211](https://github.com/jupyter/jupyter-book/issues/211) -- Don't use quotes for user-entered YAML entries [\#305](https://github.com/jupyter/jupyter-book/pull/305) ([SamLau95](https://github.com/SamLau95)) -- Set a blank excerpt for all pages [\#303](https://github.com/jupyter/jupyter-book/pull/303) ([SamLau95](https://github.com/SamLau95)) -- fixing footer width [\#301](https://github.com/jupyter/jupyter-book/pull/301) ([choldgraf](https://github.com/choldgraf)) -- Use CDNs for JS libraries [\#292](https://github.com/jupyter/jupyter-book/pull/292) ([SamLau95](https://github.com/SamLau95)) -- Load thebelab asynchronously [\#291](https://github.com/jupyter/jupyter-book/pull/291) ([SamLau95](https://github.com/SamLau95)) -- Fix missing \</div\> if page.interact\_link is false [\#290](https://github.com/jupyter/jupyter-book/pull/290) ([SamLau95](https://github.com/SamLau95)) -- fixing jupytext markdown inconsistencies [\#288](https://github.com/jupyter/jupyter-book/pull/288) ([choldgraf](https://github.com/choldgraf)) -- fixing double math printing [\#286](https://github.com/jupyter/jupyter-book/pull/286) ([choldgraf](https://github.com/choldgraf)) -- fixing up print functionality [\#284](https://github.com/jupyter/jupyter-book/pull/284) ([choldgraf](https://github.com/choldgraf)) -- making a download PDF button appear on all pages [\#282](https://github.com/jupyter/jupyter-book/pull/282) ([choldgraf](https://github.com/choldgraf)) -- fixing the TOC function [\#270](https://github.com/jupyter/jupyter-book/pull/270) ([choldgraf](https://github.com/choldgraf)) -- \[FIX\] Fix references being deleted with jupyter-upgrade [\#263](https://github.com/jupyter/jupyter-book/pull/263) ([martinagvilas](https://github.com/martinagvilas)) -- fixing links [\#260](https://github.com/jupyter/jupyter-book/pull/260) ([choldgraf](https://github.com/choldgraf)) -- adding instructions for build [\#257](https://github.com/jupyter/jupyter-book/pull/257) ([choldgraf](https://github.com/choldgraf)) -- fixing pypi description [\#256](https://github.com/jupyter/jupyter-book/pull/256) ([choldgraf](https://github.com/choldgraf)) -- version fix [\#250](https://github.com/jupyter/jupyter-book/pull/250) ([choldgraf](https://github.com/choldgraf)) +- Some small formatting issues following upgrade to master [\#296](https://github.com/ExecutableBookProject/jupyter-book/issues/296) +- Make the PDF print work for MathJax math [\#285](https://github.com/ExecutableBookProject/jupyter-book/issues/285) +- Code cells in plain Markdown files are rendered as raw text [\#283](https://github.com/ExecutableBookProject/jupyter-book/issues/283) +- 'jupyter-book upgrade' deletes new references [\#261](https://github.com/ExecutableBookProject/jupyter-book/issues/261) +- default book doesn't build properly on github - symlink error [\#237](https://github.com/ExecutableBookProject/jupyter-book/issues/237) +- Double check installation dependencies [\#211](https://github.com/ExecutableBookProject/jupyter-book/issues/211) +- Don't use quotes for user-entered YAML entries [\#305](https://github.com/ExecutableBookProject/jupyter-book/pull/305) ([SamLau95](https://github.com/SamLau95)) +- Set a blank excerpt for all pages [\#303](https://github.com/ExecutableBookProject/jupyter-book/pull/303) ([SamLau95](https://github.com/SamLau95)) +- fixing footer width [\#301](https://github.com/ExecutableBookProject/jupyter-book/pull/301) ([choldgraf](https://github.com/choldgraf)) +- Use CDNs for JS libraries [\#292](https://github.com/ExecutableBookProject/jupyter-book/pull/292) ([SamLau95](https://github.com/SamLau95)) +- Load thebelab asynchronously [\#291](https://github.com/ExecutableBookProject/jupyter-book/pull/291) ([SamLau95](https://github.com/SamLau95)) +- Fix missing \</div\> if page.interact\_link is false [\#290](https://github.com/ExecutableBookProject/jupyter-book/pull/290) ([SamLau95](https://github.com/SamLau95)) +- fixing jupytext markdown inconsistencies [\#288](https://github.com/ExecutableBookProject/jupyter-book/pull/288) ([choldgraf](https://github.com/choldgraf)) +- fixing double math printing [\#286](https://github.com/ExecutableBookProject/jupyter-book/pull/286) ([choldgraf](https://github.com/choldgraf)) +- fixing up print functionality [\#284](https://github.com/ExecutableBookProject/jupyter-book/pull/284) ([choldgraf](https://github.com/choldgraf)) +- making a download PDF button appear on all pages [\#282](https://github.com/ExecutableBookProject/jupyter-book/pull/282) ([choldgraf](https://github.com/choldgraf)) +- fixing the TOC function [\#270](https://github.com/ExecutableBookProject/jupyter-book/pull/270) ([choldgraf](https://github.com/choldgraf)) +- \[FIX\] Fix references being deleted with jupyter-upgrade [\#263](https://github.com/ExecutableBookProject/jupyter-book/pull/263) ([martinagvilas](https://github.com/martinagvilas)) +- fixing links [\#260](https://github.com/ExecutableBookProject/jupyter-book/pull/260) ([choldgraf](https://github.com/choldgraf)) +- adding instructions for build [\#257](https://github.com/ExecutableBookProject/jupyter-book/pull/257) ([choldgraf](https://github.com/choldgraf)) +- fixing pypi description [\#256](https://github.com/ExecutableBookProject/jupyter-book/pull/256) ([choldgraf](https://github.com/choldgraf)) +- version fix [\#250](https://github.com/ExecutableBookProject/jupyter-book/pull/250) ([choldgraf](https://github.com/choldgraf)) **Closed issues:** -- Jupyter Notebook can't close a running notebook [\#317](https://github.com/jupyter/jupyter-book/issues/317) -- Building book fails with a jinja2.exceptions.TemplateNotFound error [\#310](https://github.com/jupyter/jupyter-book/issues/310) -- serving non- md/ipynb content [\#295](https://github.com/jupyter/jupyter-book/issues/295) -- Broken links [\#259](https://github.com/jupyter/jupyter-book/issues/259) -- Missing file error [\#253](https://github.com/jupyter/jupyter-book/issues/253) -- Multicursor sometimes only deletes one line when there's spaces [\#251](https://github.com/jupyter/jupyter-book/issues/251) -- Release summary for v0.6 [\#331](https://github.com/jupyter/jupyter-book/issues/331) +- Jupyter Notebook can't close a running notebook [\#317](https://github.com/ExecutableBookProject/jupyter-book/issues/317) +- Building book fails with a jinja2.exceptions.TemplateNotFound error [\#310](https://github.com/ExecutableBookProject/jupyter-book/issues/310) +- serving non- md/ipynb content [\#295](https://github.com/ExecutableBookProject/jupyter-book/issues/295) +- Broken links [\#259](https://github.com/ExecutableBookProject/jupyter-book/issues/259) +- Missing file error [\#253](https://github.com/ExecutableBookProject/jupyter-book/issues/253) +- Multicursor sometimes only deletes one line when there's spaces [\#251](https://github.com/ExecutableBookProject/jupyter-book/issues/251) +- Release summary for v0.6 [\#331](https://github.com/ExecutableBookProject/jupyter-book/issues/331) **Merged pull requests:** -- fixing releases info [\#333](https://github.com/jupyter/jupyter-book/pull/333) ([choldgraf](https://github.com/choldgraf)) -- dev0 bump [\#332](https://github.com/jupyter/jupyter-book/pull/332) ([choldgraf](https://github.com/choldgraf)) -- bumping version for release [\#330](https://github.com/jupyter/jupyter-book/pull/330) ([choldgraf](https://github.com/choldgraf)) -- fixing up execute docs [\#328](https://github.com/jupyter/jupyter-book/pull/328) ([choldgraf](https://github.com/choldgraf)) -- updating documentation for build [\#326](https://github.com/jupyter/jupyter-book/pull/326) ([choldgraf](https://github.com/choldgraf)) -- adding miniconda-based test [\#324](https://github.com/jupyter/jupyter-book/pull/324) ([choldgraf](https://github.com/choldgraf)) -- removing outdated FAQ entry [\#319](https://github.com/jupyter/jupyter-book/pull/319) ([choldgraf](https://github.com/choldgraf)) -- Changes to make work with `conda skeleton pypi jupyter-book` [\#315](https://github.com/jupyter/jupyter-book/pull/315) ([krinsman](https://github.com/krinsman)) -- Update Docs to include alternative method for building Jekyll locally. [\#313](https://github.com/jupyter/jupyter-book/pull/313) ([krinsman](https://github.com/krinsman)) -- Omit entries w/o URLs and external links from TOC [\#309](https://github.com/jupyter/jupyter-book/pull/309) ([SamLau95](https://github.com/SamLau95)) -- documenting execution functionality [\#299](https://github.com/jupyter/jupyter-book/pull/299) ([choldgraf](https://github.com/choldgraf)) -- adding beta label to features [\#294](https://github.com/jupyter/jupyter-book/pull/294) ([choldgraf](https://github.com/choldgraf)) -- adding a sample CircleCI build config [\#293](https://github.com/jupyter/jupyter-book/pull/293) ([choldgraf](https://github.com/choldgraf)) -- footer width [\#287](https://github.com/jupyter/jupyter-book/pull/287) ([choldgraf](https://github.com/choldgraf)) -- adding help entries [\#277](https://github.com/jupyter/jupyter-book/pull/277) ([choldgraf](https://github.com/choldgraf)) -- Circlecibot [\#269](https://github.com/jupyter/jupyter-book/pull/269) ([choldgraf](https://github.com/choldgraf)) -- factoring out page module [\#265](https://github.com/jupyter/jupyter-book/pull/265) ([choldgraf](https://github.com/choldgraf)) -- summary not large image for twitter [\#247](https://github.com/jupyter/jupyter-book/pull/247) ([choldgraf](https://github.com/choldgraf)) -- twitter share [\#246](https://github.com/jupyter/jupyter-book/pull/246) ([choldgraf](https://github.com/choldgraf)) -- updating changelog [\#245](https://github.com/jupyter/jupyter-book/pull/245) ([choldgraf](https://github.com/choldgraf)) -- version bump to dev [\#243](https://github.com/jupyter/jupyter-book/pull/243) ([choldgraf](https://github.com/choldgraf)) - -# [v0.5.2](https://github.com/jupyter/jupyter-book/tree/v0.5.2) (2019-07-26) -[Full Changelog](https://github.com/jupyter/jupyter-book/compare/v0.5...v0.5.2) +- fixing releases info [\#333](https://github.com/ExecutableBookProject/jupyter-book/pull/333) ([choldgraf](https://github.com/choldgraf)) +- dev0 bump [\#332](https://github.com/ExecutableBookProject/jupyter-book/pull/332) ([choldgraf](https://github.com/choldgraf)) +- bumping version for release [\#330](https://github.com/ExecutableBookProject/jupyter-book/pull/330) ([choldgraf](https://github.com/choldgraf)) +- fixing up execute docs [\#328](https://github.com/ExecutableBookProject/jupyter-book/pull/328) ([choldgraf](https://github.com/choldgraf)) +- updating documentation for build [\#326](https://github.com/ExecutableBookProject/jupyter-book/pull/326) ([choldgraf](https://github.com/choldgraf)) +- adding miniconda-based test [\#324](https://github.com/ExecutableBookProject/jupyter-book/pull/324) ([choldgraf](https://github.com/choldgraf)) +- removing outdated FAQ entry [\#319](https://github.com/ExecutableBookProject/jupyter-book/pull/319) ([choldgraf](https://github.com/choldgraf)) +- Changes to make work with `conda skeleton pypi jupyter-book` [\#315](https://github.com/ExecutableBookProject/jupyter-book/pull/315) ([krinsman](https://github.com/krinsman)) +- Update Docs to include alternative method for building Jekyll locally. [\#313](https://github.com/ExecutableBookProject/jupyter-book/pull/313) ([krinsman](https://github.com/krinsman)) +- Omit entries w/o URLs and external links from TOC [\#309](https://github.com/ExecutableBookProject/jupyter-book/pull/309) ([SamLau95](https://github.com/SamLau95)) +- documenting execution functionality [\#299](https://github.com/ExecutableBookProject/jupyter-book/pull/299) ([choldgraf](https://github.com/choldgraf)) +- adding beta label to features [\#294](https://github.com/ExecutableBookProject/jupyter-book/pull/294) ([choldgraf](https://github.com/choldgraf)) +- adding a sample CircleCI build config [\#293](https://github.com/ExecutableBookProject/jupyter-book/pull/293) ([choldgraf](https://github.com/choldgraf)) +- footer width [\#287](https://github.com/ExecutableBookProject/jupyter-book/pull/287) ([choldgraf](https://github.com/choldgraf)) +- adding help entries [\#277](https://github.com/ExecutableBookProject/jupyter-book/pull/277) ([choldgraf](https://github.com/choldgraf)) +- Circlecibot [\#269](https://github.com/ExecutableBookProject/jupyter-book/pull/269) ([choldgraf](https://github.com/choldgraf)) +- factoring out page module [\#265](https://github.com/ExecutableBookProject/jupyter-book/pull/265) ([choldgraf](https://github.com/choldgraf)) +- summary not large image for twitter [\#247](https://github.com/ExecutableBookProject/jupyter-book/pull/247) ([choldgraf](https://github.com/choldgraf)) +- twitter share [\#246](https://github.com/ExecutableBookProject/jupyter-book/pull/246) ([choldgraf](https://github.com/choldgraf)) +- updating changelog [\#245](https://github.com/ExecutableBookProject/jupyter-book/pull/245) ([choldgraf](https://github.com/choldgraf)) +- version bump to dev [\#243](https://github.com/ExecutableBookProject/jupyter-book/pull/243) ([choldgraf](https://github.com/choldgraf)) + +# [v0.5.2](https://github.com/ExecutableBookProject/jupyter-book/tree/v0.5.2) (2019-07-26) +[Full Changelog](https://github.com/ExecutableBookProject/jupyter-book/compare/v0.5...v0.5.2) **Implemented enhancements:** -- implement removecell for markdown cells [\#192](https://github.com/jupyter/jupyter-book/issues/192) +- implement removecell for markdown cells [\#192](https://github.com/ExecutableBookProject/jupyter-book/issues/192) **Fixed bugs:** -- yaml.load\(\) is unsafe [\#230](https://github.com/jupyter/jupyter-book/issues/230) -- Update documentation links that are broken [\#224](https://github.com/jupyter/jupyter-book/issues/224) -- pip installation: jupyter-book or jupyter\_book? [\#184](https://github.com/jupyter/jupyter-book/issues/184) -- Figure out why Gemfile and Gemfile.lock are causing issues [\#154](https://github.com/jupyter/jupyter-book/issues/154) -- Page turn link URLs missing .html [\#140](https://github.com/jupyter/jupyter-book/issues/140) -- Errors when running on Windows [\#137](https://github.com/jupyter/jupyter-book/issues/137) -- Docs aren't being updated from master [\#136](https://github.com/jupyter/jupyter-book/issues/136) -- toc help is incorrect [\#132](https://github.com/jupyter/jupyter-book/issues/132) +- yaml.load\(\) is unsafe [\#230](https://github.com/ExecutableBookProject/jupyter-book/issues/230) +- Update documentation links that are broken [\#224](https://github.com/ExecutableBookProject/jupyter-book/issues/224) +- pip installation: jupyter-book or jupyter\_book? [\#184](https://github.com/ExecutableBookProject/jupyter-book/issues/184) +- Figure out why Gemfile and Gemfile.lock are causing issues [\#154](https://github.com/ExecutableBookProject/jupyter-book/issues/154) +- Page turn link URLs missing .html [\#140](https://github.com/ExecutableBookProject/jupyter-book/issues/140) +- Errors when running on Windows [\#137](https://github.com/ExecutableBookProject/jupyter-book/issues/137) +- Docs aren't being updated from master [\#136](https://github.com/ExecutableBookProject/jupyter-book/issues/136) +- toc help is incorrect [\#132](https://github.com/ExecutableBookProject/jupyter-book/issues/132) **Closed issues:** -- Update docs about how to hide code cells [\#240](https://github.com/jupyter/jupyter-book/issues/240) -- Is it possible to export Word, PDF and other formats? [\#228](https://github.com/jupyter/jupyter-book/issues/228) -- Make it clear in the documentation that the full docker path needs to be specified, not the relative path [\#220](https://github.com/jupyter/jupyter-book/issues/220) -- Why do we have "content" directory inside the "\_site"? [\#219](https://github.com/jupyter/jupyter-book/issues/219) -- mismatch in docs and functionality [\#214](https://github.com/jupyter/jupyter-book/issues/214) -- Double check that `generate\_toc.py` is getting copied properly [\#210](https://github.com/jupyter/jupyter-book/issues/210) -- jupyter-book cli does not work as stated in the getting started guide [\#208](https://github.com/jupyter/jupyter-book/issues/208) -- Unable to install jupyter-book in conda environment [\#206](https://github.com/jupyter/jupyter-book/issues/206) -- Error if kernelspec missing [\#195](https://github.com/jupyter/jupyter-book/issues/195) -- Clarify the CLI help statements [\#146](https://github.com/jupyter/jupyter-book/issues/146) -- jupyter-book upgrade also modifies requirements.txt [\#130](https://github.com/jupyter/jupyter-book/issues/130) +- Update docs about how to hide code cells [\#240](https://github.com/ExecutableBookProject/jupyter-book/issues/240) +- Is it possible to export Word, PDF and other formats? [\#228](https://github.com/ExecutableBookProject/jupyter-book/issues/228) +- Make it clear in the documentation that the full docker path needs to be specified, not the relative path [\#220](https://github.com/ExecutableBookProject/jupyter-book/issues/220) +- Why do we have "content" directory inside the "\_site"? [\#219](https://github.com/ExecutableBookProject/jupyter-book/issues/219) +- mismatch in docs and functionality [\#214](https://github.com/ExecutableBookProject/jupyter-book/issues/214) +- Double check that `generate\_toc.py` is getting copied properly [\#210](https://github.com/ExecutableBookProject/jupyter-book/issues/210) +- jupyter-book cli does not work as stated in the getting started guide [\#208](https://github.com/ExecutableBookProject/jupyter-book/issues/208) +- Unable to install jupyter-book in conda environment [\#206](https://github.com/ExecutableBookProject/jupyter-book/issues/206) +- Error if kernelspec missing [\#195](https://github.com/ExecutableBookProject/jupyter-book/issues/195) +- Clarify the CLI help statements [\#146](https://github.com/ExecutableBookProject/jupyter-book/issues/146) +- jupyter-book upgrade also modifies requirements.txt [\#130](https://github.com/ExecutableBookProject/jupyter-book/issues/130) **Merged pull requests:** -- bumping version and adding CLI for version [\#242](https://github.com/jupyter/jupyter-book/pull/242) ([choldgraf](https://github.com/choldgraf)) -- Release fixes [\#241](https://github.com/jupyter/jupyter-book/pull/241) ([choldgraf](https://github.com/choldgraf)) -- Markdown exporter in Python instead of the CLI [\#235](https://github.com/jupyter/jupyter-book/pull/235) ([choldgraf](https://github.com/choldgraf)) -- Change text in Markdown cell to correct URL. [\#227](https://github.com/jupyter/jupyter-book/pull/227) ([habi](https://github.com/habi)) -- \[DOC\] Clarify full vs relative path in container build instructions [\#226](https://github.com/jupyter/jupyter-book/pull/226) ([emdupre](https://github.com/emdupre)) -- Ensure UTF-8 Encoding When Building Book [\#225](https://github.com/jupyter/jupyter-book/pull/225) ([cczhu](https://github.com/cczhu)) -- version bump to dev [\#218](https://github.com/jupyter/jupyter-book/pull/218) ([choldgraf](https://github.com/choldgraf)) -- version bump for bugfix [\#217](https://github.com/jupyter/jupyter-book/pull/217) ([choldgraf](https://github.com/choldgraf)) -- fix doc mismatch for "make build" [\#216](https://github.com/jupyter/jupyter-book/pull/216) ([thammegowda](https://github.com/thammegowda)) -- make scripts dir as a module, to be included by `find\_packages\(\)` of setuptools [\#215](https://github.com/jupyter/jupyter-book/pull/215) ([thammegowda](https://github.com/thammegowda)) -- add jupyter book to template requirements [\#209](https://github.com/jupyter/jupyter-book/pull/209) ([choldgraf](https://github.com/choldgraf)) -- updating hidecode tag word and allowing total HTML removal [\#207](https://github.com/jupyter/jupyter-book/pull/207) ([choldgraf](https://github.com/choldgraf)) -- Ask if kernelspec exists in metadata [\#197](https://github.com/jupyter/jupyter-book/pull/197) ([joergbrech](https://github.com/joergbrech)) -- changelog and version bump [\#194](https://github.com/jupyter/jupyter-book/pull/194) ([choldgraf](https://github.com/choldgraf)) - -# [v0.5](https://github.com/jupyter/jupyter-book/tree/v0.5) (2019-05-13) -[Full Changelog](https://github.com/jupyter/jupyter-book/compare/v0.4.1...v0.5) +- bumping version and adding CLI for version [\#242](https://github.com/ExecutableBookProject/jupyter-book/pull/242) ([choldgraf](https://github.com/choldgraf)) +- Release fixes [\#241](https://github.com/ExecutableBookProject/jupyter-book/pull/241) ([choldgraf](https://github.com/choldgraf)) +- Markdown exporter in Python instead of the CLI [\#235](https://github.com/ExecutableBookProject/jupyter-book/pull/235) ([choldgraf](https://github.com/choldgraf)) +- Change text in Markdown cell to correct URL. [\#227](https://github.com/ExecutableBookProject/jupyter-book/pull/227) ([habi](https://github.com/habi)) +- \[DOC\] Clarify full vs relative path in container build instructions [\#226](https://github.com/ExecutableBookProject/jupyter-book/pull/226) ([emdupre](https://github.com/emdupre)) +- Ensure UTF-8 Encoding When Building Book [\#225](https://github.com/ExecutableBookProject/jupyter-book/pull/225) ([cczhu](https://github.com/cczhu)) +- version bump to dev [\#218](https://github.com/ExecutableBookProject/jupyter-book/pull/218) ([choldgraf](https://github.com/choldgraf)) +- version bump for bugfix [\#217](https://github.com/ExecutableBookProject/jupyter-book/pull/217) ([choldgraf](https://github.com/choldgraf)) +- fix doc mismatch for "make build" [\#216](https://github.com/ExecutableBookProject/jupyter-book/pull/216) ([thammegowda](https://github.com/thammegowda)) +- make scripts dir as a module, to be included by `find\_packages\(\)` of setuptools [\#215](https://github.com/ExecutableBookProject/jupyter-book/pull/215) ([thammegowda](https://github.com/thammegowda)) +- add jupyter book to template requirements [\#209](https://github.com/ExecutableBookProject/jupyter-book/pull/209) ([choldgraf](https://github.com/choldgraf)) +- updating hidecode tag word and allowing total HTML removal [\#207](https://github.com/ExecutableBookProject/jupyter-book/pull/207) ([choldgraf](https://github.com/choldgraf)) +- Ask if kernelspec exists in metadata [\#197](https://github.com/ExecutableBookProject/jupyter-book/pull/197) ([joergbrech](https://github.com/joergbrech)) +- changelog and version bump [\#194](https://github.com/ExecutableBookProject/jupyter-book/pull/194) ([choldgraf](https://github.com/choldgraf)) + +# [v0.5](https://github.com/ExecutableBookProject/jupyter-book/tree/v0.5) (2019-05-13) +[Full Changelog](https://github.com/ExecutableBookProject/jupyter-book/compare/v0.4.1...v0.5) **Implemented enhancements:** -- Markdown guide refers to Highlightjs but Rouge is used [\#183](https://github.com/jupyter/jupyter-book/issues/183) -- Get codecov working [\#153](https://github.com/jupyter/jupyter-book/issues/153) -- Add thebelab button to every code cell [\#117](https://github.com/jupyter/jupyter-book/issues/117) -- Add an option / config for analytics tracking? [\#115](https://github.com/jupyter/jupyter-book/issues/115) -- Add support for nbinteract [\#82](https://github.com/jupyter/jupyter-book/issues/82) -- Scrolling in subtitle column [\#173](https://github.com/jupyter/jupyter-book/issues/173) +- Markdown guide refers to Highlightjs but Rouge is used [\#183](https://github.com/ExecutableBookProject/jupyter-book/issues/183) +- Get codecov working [\#153](https://github.com/ExecutableBookProject/jupyter-book/issues/153) +- Add thebelab button to every code cell [\#117](https://github.com/ExecutableBookProject/jupyter-book/issues/117) +- Add an option / config for analytics tracking? [\#115](https://github.com/ExecutableBookProject/jupyter-book/issues/115) +- Add support for nbinteract [\#82](https://github.com/ExecutableBookProject/jupyter-book/issues/82) +- Scrolling in subtitle column [\#173](https://github.com/ExecutableBookProject/jupyter-book/issues/173) **Fixed bugs:** -- Page turn links to external sites are broken [\#186](https://github.com/jupyter/jupyter-book/issues/186) -- Code cell pre-wrap causes split lines [\#182](https://github.com/jupyter/jupyter-book/issues/182) -- problems building with images [\#124](https://github.com/jupyter/jupyter-book/issues/124) -- Problems with local build instructions on Mac \(and perhaps other 'nix platforms\) [\#123](https://github.com/jupyter/jupyter-book/issues/123) +- Page turn links to external sites are broken [\#186](https://github.com/ExecutableBookProject/jupyter-book/issues/186) +- Code cell pre-wrap causes split lines [\#182](https://github.com/ExecutableBookProject/jupyter-book/issues/182) +- problems building with images [\#124](https://github.com/ExecutableBookProject/jupyter-book/issues/124) +- Problems with local build instructions on Mac \(and perhaps other 'nix platforms\) [\#123](https://github.com/ExecutableBookProject/jupyter-book/issues/123) **Closed issues:** -- Plots not showing in ipynb files [\#179](https://github.com/jupyter/jupyter-book/issues/179) -- jupyter-book is missing from the binder requirements [\#166](https://github.com/jupyter/jupyter-book/issues/166) -- Binder and Thebelab not working for demo book [\#155](https://github.com/jupyter/jupyter-book/issues/155) -- Errors building HTML [\#152](https://github.com/jupyter/jupyter-book/issues/152) -- Non `--demo` option seems to fail [\#120](https://github.com/jupyter/jupyter-book/issues/120) -- Error on notebook.py with inconsistent and DEFAULT\_STATIC\_FILES\_PATH. [\#108](https://github.com/jupyter/jupyter-book/issues/108) -- add requirements to setup.py [\#105](https://github.com/jupyter/jupyter-book/issues/105) -- Add a CONTRIBUTING.md [\#99](https://github.com/jupyter/jupyter-book/issues/99) -- Explore using a cookiecutter for the site [\#87](https://github.com/jupyter/jupyter-book/issues/87) -- Use a Python CLI instead of Make [\#42](https://github.com/jupyter/jupyter-book/issues/42) -- Autogenerate toc [\#40](https://github.com/jupyter/jupyter-book/issues/40) -- Force permalinks to be lowercase and replace space and '\_' with '-' [\#35](https://github.com/jupyter/jupyter-book/issues/35) -- Extra buttons to support [\#32](https://github.com/jupyter/jupyter-book/issues/32) -- Use a submodule for notebooks folder [\#14](https://github.com/jupyter/jupyter-book/issues/14) -- Jupyter Book version v0.5 [\#175](https://github.com/jupyter/jupyter-book/issues/175) +- Plots not showing in ipynb files [\#179](https://github.com/ExecutableBookProject/jupyter-book/issues/179) +- jupyter-book is missing from the binder requirements [\#166](https://github.com/ExecutableBookProject/jupyter-book/issues/166) +- Binder and Thebelab not working for demo book [\#155](https://github.com/ExecutableBookProject/jupyter-book/issues/155) +- Errors building HTML [\#152](https://github.com/ExecutableBookProject/jupyter-book/issues/152) +- Non `--demo` option seems to fail [\#120](https://github.com/ExecutableBookProject/jupyter-book/issues/120) +- Error on notebook.py with inconsistent and DEFAULT\_STATIC\_FILES\_PATH. [\#108](https://github.com/ExecutableBookProject/jupyter-book/issues/108) +- add requirements to setup.py [\#105](https://github.com/ExecutableBookProject/jupyter-book/issues/105) +- Add a CONTRIBUTING.md [\#99](https://github.com/ExecutableBookProject/jupyter-book/issues/99) +- Explore using a cookiecutter for the site [\#87](https://github.com/ExecutableBookProject/jupyter-book/issues/87) +- Use a Python CLI instead of Make [\#42](https://github.com/ExecutableBookProject/jupyter-book/issues/42) +- Autogenerate toc [\#40](https://github.com/ExecutableBookProject/jupyter-book/issues/40) +- Force permalinks to be lowercase and replace space and '\_' with '-' [\#35](https://github.com/ExecutableBookProject/jupyter-book/issues/35) +- Extra buttons to support [\#32](https://github.com/ExecutableBookProject/jupyter-book/issues/32) +- Use a submodule for notebooks folder [\#14](https://github.com/ExecutableBookProject/jupyter-book/issues/14) +- Jupyter Book version v0.5 [\#175](https://github.com/ExecutableBookProject/jupyter-book/issues/175) **Merged pull requests:** -- Release [\#193](https://github.com/jupyter/jupyter-book/pull/193) ([choldgraf](https://github.com/choldgraf)) -- Update local install instructions [\#190](https://github.com/jupyter/jupyter-book/pull/190) ([mwcraig](https://github.com/mwcraig)) -- fixing some css bugs [\#188](https://github.com/jupyter/jupyter-book/pull/188) ([choldgraf](https://github.com/choldgraf)) -- \[FIX\] Issue \#137 Errors when running on Windows [\#187](https://github.com/jupyter/jupyter-book/pull/187) ([stafforddavidj](https://github.com/stafforddavidj)) -- fixing content root notebook problem [\#181](https://github.com/jupyter/jupyter-book/pull/181) ([choldgraf](https://github.com/choldgraf)) -- wrap code even if it has no language [\#180](https://github.com/jupyter/jupyter-book/pull/180) ([alexmorley](https://github.com/alexmorley)) -- removing custom TOC code [\#178](https://github.com/jupyter/jupyter-book/pull/178) ([choldgraf](https://github.com/choldgraf)) -- Make right hand toc scrollable. [\#176](https://github.com/jupyter/jupyter-book/pull/176) ([alexmorley](https://github.com/alexmorley)) -- adding cell tags metadata [\#171](https://github.com/jupyter/jupyter-book/pull/171) ([choldgraf](https://github.com/choldgraf)) -- make sure jupyter-book is included in the binder build [\#167](https://github.com/jupyter/jupyter-book/pull/167) ([joergbrech](https://github.com/joergbrech)) -- fixing thebelab css and splitting off the interactive notebooks [\#165](https://github.com/jupyter/jupyter-book/pull/165) ([choldgraf](https://github.com/choldgraf)) -- \[ENH\] Add thebelab button to every code cell [\#163](https://github.com/jupyter/jupyter-book/pull/163) ([joergbrech](https://github.com/joergbrech)) -- making tags for removing cells not text [\#162](https://github.com/jupyter/jupyter-book/pull/162) ([choldgraf](https://github.com/choldgraf)) -- hide cells updates [\#161](https://github.com/jupyter/jupyter-book/pull/161) ([choldgraf](https://github.com/choldgraf)) -- updating css to match input and output [\#160](https://github.com/jupyter/jupyter-book/pull/160) ([choldgraf](https://github.com/choldgraf)) -- Update config.yml for code coverage [\#159](https://github.com/jupyter/jupyter-book/pull/159) ([choldgraf](https://github.com/choldgraf)) -- codecov activation [\#158](https://github.com/jupyter/jupyter-book/pull/158) ([choldgraf](https://github.com/choldgraf)) -- Update requirements.txt [\#157](https://github.com/jupyter/jupyter-book/pull/157) ([choldgraf](https://github.com/choldgraf)) -- binder links to gh-pages now [\#156](https://github.com/jupyter/jupyter-book/pull/156) ([choldgraf](https://github.com/choldgraf)) -- Fix broken notebook links [\#150](https://github.com/jupyter/jupyter-book/pull/150) ([mwcraig](https://github.com/mwcraig)) -- fixing thebelab and circle build [\#149](https://github.com/jupyter/jupyter-book/pull/149) ([choldgraf](https://github.com/choldgraf)) -- removing build folder [\#144](https://github.com/jupyter/jupyter-book/pull/144) ([choldgraf](https://github.com/choldgraf)) -- maintaining docs for site structure [\#142](https://github.com/jupyter/jupyter-book/pull/142) ([choldgraf](https://github.com/choldgraf)) -- Build update [\#135](https://github.com/jupyter/jupyter-book/pull/135) ([choldgraf](https://github.com/choldgraf)) -- Release guide [\#131](https://github.com/jupyter/jupyter-book/pull/131) ([choldgraf](https://github.com/choldgraf)) -- \[MRG\] Refactor argparse [\#129](https://github.com/jupyter/jupyter-book/pull/129) ([jasmainak](https://github.com/jasmainak)) -- Add badge for coverage [\#128](https://github.com/jupyter/jupyter-book/pull/128) ([jasmainak](https://github.com/jasmainak)) -- \[ENH\] Initial commit of dockerfile, updated docs [\#127](https://github.com/jupyter/jupyter-book/pull/127) ([emdupre](https://github.com/emdupre)) -- MAINT: make jupyter-book conform to pep8 [\#126](https://github.com/jupyter/jupyter-book/pull/126) ([jasmainak](https://github.com/jasmainak)) -- linking minimal folder [\#122](https://github.com/jupyter/jupyter-book/pull/122) ([choldgraf](https://github.com/choldgraf)) -- adding nbinteract support [\#119](https://github.com/jupyter/jupyter-book/pull/119) ([choldgraf](https://github.com/choldgraf)) -- update link of the markdown version of guide [\#118](https://github.com/jupyter/jupyter-book/pull/118) ([cnydw](https://github.com/cnydw)) -- \[ENH\] add google analytics option [\#116](https://github.com/jupyter/jupyter-book/pull/116) ([joergbrech](https://github.com/joergbrech)) -- improving the non-sidebar layout and toc script [\#112](https://github.com/jupyter/jupyter-book/pull/112) ([choldgraf](https://github.com/choldgraf)) -- \[doc\] contributing guidelines [\#111](https://github.com/jupyter/jupyter-book/pull/111) ([emdupre](https://github.com/emdupre)) -- Cssfix [\#109](https://github.com/jupyter/jupyter-book/pull/109) ([choldgraf](https://github.com/choldgraf)) -- source dependencies from requirements.txt [\#106](https://github.com/jupyter/jupyter-book/pull/106) ([Zsailer](https://github.com/Zsailer)) -- Adding download links for the notebook files [\#104](https://github.com/jupyter/jupyter-book/pull/104) ([choldgraf](https://github.com/choldgraf)) -- fixing thebelab keyboard shortcuts behavior [\#103](https://github.com/jupyter/jupyter-book/pull/103) ([choldgraf](https://github.com/choldgraf)) - -# [v0.4.1](https://github.com/jupyter/jupyter-book/tree/v0.4.1) (2019-02-09) -[Full Changelog](https://github.com/jupyter/jupyter-book/compare/v0.2...v0.4.1) +- Release [\#193](https://github.com/ExecutableBookProject/jupyter-book/pull/193) ([choldgraf](https://github.com/choldgraf)) +- Update local install instructions [\#190](https://github.com/ExecutableBookProject/jupyter-book/pull/190) ([mwcraig](https://github.com/mwcraig)) +- fixing some css bugs [\#188](https://github.com/ExecutableBookProject/jupyter-book/pull/188) ([choldgraf](https://github.com/choldgraf)) +- \[FIX\] Issue \#137 Errors when running on Windows [\#187](https://github.com/ExecutableBookProject/jupyter-book/pull/187) ([stafforddavidj](https://github.com/stafforddavidj)) +- fixing content root notebook problem [\#181](https://github.com/ExecutableBookProject/jupyter-book/pull/181) ([choldgraf](https://github.com/choldgraf)) +- wrap code even if it has no language [\#180](https://github.com/ExecutableBookProject/jupyter-book/pull/180) ([alexmorley](https://github.com/alexmorley)) +- removing custom TOC code [\#178](https://github.com/ExecutableBookProject/jupyter-book/pull/178) ([choldgraf](https://github.com/choldgraf)) +- Make right hand toc scrollable. [\#176](https://github.com/ExecutableBookProject/jupyter-book/pull/176) ([alexmorley](https://github.com/alexmorley)) +- adding cell tags metadata [\#171](https://github.com/ExecutableBookProject/jupyter-book/pull/171) ([choldgraf](https://github.com/choldgraf)) +- make sure jupyter-book is included in the binder build [\#167](https://github.com/ExecutableBookProject/jupyter-book/pull/167) ([joergbrech](https://github.com/joergbrech)) +- fixing thebelab css and splitting off the interactive notebooks [\#165](https://github.com/ExecutableBookProject/jupyter-book/pull/165) ([choldgraf](https://github.com/choldgraf)) +- \[ENH\] Add thebelab button to every code cell [\#163](https://github.com/ExecutableBookProject/jupyter-book/pull/163) ([joergbrech](https://github.com/joergbrech)) +- making tags for removing cells not text [\#162](https://github.com/ExecutableBookProject/jupyter-book/pull/162) ([choldgraf](https://github.com/choldgraf)) +- hide cells updates [\#161](https://github.com/ExecutableBookProject/jupyter-book/pull/161) ([choldgraf](https://github.com/choldgraf)) +- updating css to match input and output [\#160](https://github.com/ExecutableBookProject/jupyter-book/pull/160) ([choldgraf](https://github.com/choldgraf)) +- Update config.yml for code coverage [\#159](https://github.com/ExecutableBookProject/jupyter-book/pull/159) ([choldgraf](https://github.com/choldgraf)) +- codecov activation [\#158](https://github.com/ExecutableBookProject/jupyter-book/pull/158) ([choldgraf](https://github.com/choldgraf)) +- Update requirements.txt [\#157](https://github.com/ExecutableBookProject/jupyter-book/pull/157) ([choldgraf](https://github.com/choldgraf)) +- binder links to gh-pages now [\#156](https://github.com/ExecutableBookProject/jupyter-book/pull/156) ([choldgraf](https://github.com/choldgraf)) +- Fix broken notebook links [\#150](https://github.com/ExecutableBookProject/jupyter-book/pull/150) ([mwcraig](https://github.com/mwcraig)) +- fixing thebelab and circle build [\#149](https://github.com/ExecutableBookProject/jupyter-book/pull/149) ([choldgraf](https://github.com/choldgraf)) +- removing build folder [\#144](https://github.com/ExecutableBookProject/jupyter-book/pull/144) ([choldgraf](https://github.com/choldgraf)) +- maintaining docs for site structure [\#142](https://github.com/ExecutableBookProject/jupyter-book/pull/142) ([choldgraf](https://github.com/choldgraf)) +- Build update [\#135](https://github.com/ExecutableBookProject/jupyter-book/pull/135) ([choldgraf](https://github.com/choldgraf)) +- Release guide [\#131](https://github.com/ExecutableBookProject/jupyter-book/pull/131) ([choldgraf](https://github.com/choldgraf)) +- \[MRG\] Refactor argparse [\#129](https://github.com/ExecutableBookProject/jupyter-book/pull/129) ([jasmainak](https://github.com/jasmainak)) +- Add badge for coverage [\#128](https://github.com/ExecutableBookProject/jupyter-book/pull/128) ([jasmainak](https://github.com/jasmainak)) +- \[ENH\] Initial commit of dockerfile, updated docs [\#127](https://github.com/ExecutableBookProject/jupyter-book/pull/127) ([emdupre](https://github.com/emdupre)) +- MAINT: make jupyter-book conform to pep8 [\#126](https://github.com/ExecutableBookProject/jupyter-book/pull/126) ([jasmainak](https://github.com/jasmainak)) +- linking minimal folder [\#122](https://github.com/ExecutableBookProject/jupyter-book/pull/122) ([choldgraf](https://github.com/choldgraf)) +- adding nbinteract support [\#119](https://github.com/ExecutableBookProject/jupyter-book/pull/119) ([choldgraf](https://github.com/choldgraf)) +- update link of the markdown version of guide [\#118](https://github.com/ExecutableBookProject/jupyter-book/pull/118) ([cnydw](https://github.com/cnydw)) +- \[ENH\] add google analytics option [\#116](https://github.com/ExecutableBookProject/jupyter-book/pull/116) ([joergbrech](https://github.com/joergbrech)) +- improving the non-sidebar layout and toc script [\#112](https://github.com/ExecutableBookProject/jupyter-book/pull/112) ([choldgraf](https://github.com/choldgraf)) +- \[doc\] contributing guidelines [\#111](https://github.com/ExecutableBookProject/jupyter-book/pull/111) ([emdupre](https://github.com/emdupre)) +- Cssfix [\#109](https://github.com/ExecutableBookProject/jupyter-book/pull/109) ([choldgraf](https://github.com/choldgraf)) +- source dependencies from requirements.txt [\#106](https://github.com/ExecutableBookProject/jupyter-book/pull/106) ([Zsailer](https://github.com/Zsailer)) +- Adding download links for the notebook files [\#104](https://github.com/ExecutableBookProject/jupyter-book/pull/104) ([choldgraf](https://github.com/choldgraf)) +- fixing thebelab keyboard shortcuts behavior [\#103](https://github.com/ExecutableBookProject/jupyter-book/pull/103) ([choldgraf](https://github.com/choldgraf)) + +# [v0.4.1](https://github.com/ExecutableBookProject/jupyter-book/tree/v0.4.1) (2019-02-09) +[Full Changelog](https://github.com/ExecutableBookProject/jupyter-book/compare/v0.2...v0.4.1) **Closed issues:** -- Disappearing None [\#98](https://github.com/jupyter/jupyter-book/issues/98) -- Inquiry: Plotly interactive plots in a Jupyter Books? [\#93](https://github.com/jupyter/jupyter-book/issues/93) -- iframe not rendering [\#91](https://github.com/jupyter/jupyter-book/issues/91) -- thebelab uses the wrong kernel [\#90](https://github.com/jupyter/jupyter-book/issues/90) -- An option to embed a link on sidebar logo [\#77](https://github.com/jupyter/jupyter-book/issues/77) -- Scrollbar overlaps with TOC table \(on Linux\) [\#75](https://github.com/jupyter/jupyter-book/issues/75) -- Unwanted leading white space at the beginning of code block [\#73](https://github.com/jupyter/jupyter-book/issues/73) -- Standard badges rendering too big [\#65](https://github.com/jupyter/jupyter-book/issues/65) -- Give a shout-out to bookdown [\#63](https://github.com/jupyter/jupyter-book/issues/63) -- Make it clearer how to customize the look and feel of the site [\#61](https://github.com/jupyter/jupyter-book/issues/61) -- Recommend a way to make citations [\#60](https://github.com/jupyter/jupyter-book/issues/60) -- Highlight active section in right sidebar [\#55](https://github.com/jupyter/jupyter-book/issues/55) -- Allow people to put YAML in their content files [\#51](https://github.com/jupyter/jupyter-book/issues/51) -- Site Search [\#39](https://github.com/jupyter/jupyter-book/issues/39) -- Conversion from old system to new [\#37](https://github.com/jupyter/jupyter-book/issues/37) -- Support "versions" of a book [\#31](https://github.com/jupyter/jupyter-book/issues/31) -- Book is not rebuilding [\#29](https://github.com/jupyter/jupyter-book/issues/29) -- Feature request: right-side navbar auto-scroll [\#24](https://github.com/jupyter/jupyter-book/issues/24) -- generate\_summary\_from\_folders doesn't output prefixed numerals [\#23](https://github.com/jupyter/jupyter-book/issues/23) +- Disappearing None [\#98](https://github.com/ExecutableBookProject/jupyter-book/issues/98) +- Inquiry: Plotly interactive plots in a Jupyter Books? [\#93](https://github.com/ExecutableBookProject/jupyter-book/issues/93) +- iframe not rendering [\#91](https://github.com/ExecutableBookProject/jupyter-book/issues/91) +- thebelab uses the wrong kernel [\#90](https://github.com/ExecutableBookProject/jupyter-book/issues/90) +- An option to embed a link on sidebar logo [\#77](https://github.com/ExecutableBookProject/jupyter-book/issues/77) +- Scrollbar overlaps with TOC table \(on Linux\) [\#75](https://github.com/ExecutableBookProject/jupyter-book/issues/75) +- Unwanted leading white space at the beginning of code block [\#73](https://github.com/ExecutableBookProject/jupyter-book/issues/73) +- Standard badges rendering too big [\#65](https://github.com/ExecutableBookProject/jupyter-book/issues/65) +- Give a shout-out to bookdown [\#63](https://github.com/ExecutableBookProject/jupyter-book/issues/63) +- Make it clearer how to customize the look and feel of the site [\#61](https://github.com/ExecutableBookProject/jupyter-book/issues/61) +- Recommend a way to make citations [\#60](https://github.com/ExecutableBookProject/jupyter-book/issues/60) +- Highlight active section in right sidebar [\#55](https://github.com/ExecutableBookProject/jupyter-book/issues/55) +- Allow people to put YAML in their content files [\#51](https://github.com/ExecutableBookProject/jupyter-book/issues/51) +- Site Search [\#39](https://github.com/ExecutableBookProject/jupyter-book/issues/39) +- Conversion from old system to new [\#37](https://github.com/ExecutableBookProject/jupyter-book/issues/37) +- Support "versions" of a book [\#31](https://github.com/ExecutableBookProject/jupyter-book/issues/31) +- Book is not rebuilding [\#29](https://github.com/ExecutableBookProject/jupyter-book/issues/29) +- Feature request: right-side navbar auto-scroll [\#24](https://github.com/ExecutableBookProject/jupyter-book/issues/24) +- generate\_summary\_from\_folders doesn't output prefixed numerals [\#23](https://github.com/ExecutableBookProject/jupyter-book/issues/23) **Merged pull requests:** -- fixing thebelab keyboard movement [\#102](https://github.com/jupyter/jupyter-book/pull/102) ([choldgraf](https://github.com/choldgraf)) -- Styles [\#101](https://github.com/jupyter/jupyter-book/pull/101) ([choldgraf](https://github.com/choldgraf)) -- Update FAQ with guidelines for Plotly [\#97](https://github.com/jupyter/jupyter-book/pull/97) ([mathieuboudreau](https://github.com/mathieuboudreau)) -- set kernelOptions for thebelab based on notebook's metadata [\#92](https://github.com/jupyter/jupyter-book/pull/92) ([joergbrech](https://github.com/joergbrech)) -- \[WIP\] adding a CLI to generate books [\#89](https://github.com/jupyter/jupyter-book/pull/89) ([choldgraf](https://github.com/choldgraf)) -- Fix very small typo [\#88](https://github.com/jupyter/jupyter-book/pull/88) ([mwcraig](https://github.com/mwcraig)) -- adding update instructions [\#86](https://github.com/jupyter/jupyter-book/pull/86) ([choldgraf](https://github.com/choldgraf)) -- adding search functionality and external links in sidebar [\#85](https://github.com/jupyter/jupyter-book/pull/85) ([choldgraf](https://github.com/choldgraf)) -- adding codemirror theme config [\#84](https://github.com/jupyter/jupyter-book/pull/84) ([choldgraf](https://github.com/choldgraf)) -- ignoring gh-pages for circle [\#81](https://github.com/jupyter/jupyter-book/pull/81) ([choldgraf](https://github.com/choldgraf)) -- transferring over book to new owner [\#80](https://github.com/jupyter/jupyter-book/pull/80) ([choldgraf](https://github.com/choldgraf)) -- sidebar logo link [\#79](https://github.com/jupyter/jupyter-book/pull/79) ([choldgraf](https://github.com/choldgraf)) -- improve codemirror syntax highlighting [\#78](https://github.com/jupyter/jupyter-book/pull/78) ([choldgraf](https://github.com/choldgraf)) -- updating sidebar css to be more minimal [\#76](https://github.com/jupyter/jupyter-book/pull/76) ([choldgraf](https://github.com/choldgraf)) -- Rebuild file if source file has a newer time stamp [\#74](https://github.com/jupyter/jupyter-book/pull/74) ([gaow](https://github.com/gaow)) -- Deploy to github.io using circle and update docs to reflect this [\#69](https://github.com/jupyter/jupyter-book/pull/69) ([choldgraf](https://github.com/choldgraf)) -- updating requirements for binder [\#67](https://github.com/jupyter/jupyter-book/pull/67) ([choldgraf](https://github.com/choldgraf)) -- adding thebelab buttons and some other updates [\#66](https://github.com/jupyter/jupyter-book/pull/66) ([choldgraf](https://github.com/choldgraf)) -- adding citations support [\#64](https://github.com/jupyter/jupyter-book/pull/64) ([choldgraf](https://github.com/choldgraf)) -- adding collapsible code blocks [\#59](https://github.com/jupyter/jupyter-book/pull/59) ([choldgraf](https://github.com/choldgraf)) -- highlighting to right menu bar [\#58](https://github.com/jupyter/jupyter-book/pull/58) ([choldgraf](https://github.com/choldgraf)) -- updating install instructions to use conda [\#57](https://github.com/jupyter/jupyter-book/pull/57) ([choldgraf](https://github.com/choldgraf)) -- adding ruby to circle [\#56](https://github.com/jupyter/jupyter-book/pull/56) ([choldgraf](https://github.com/choldgraf)) -- Make the sidebar stay on the page during scroll [\#54](https://github.com/jupyter/jupyter-book/pull/54) ([ReventonC](https://github.com/ReventonC)) -- adding mini module and yaml splitter [\#53](https://github.com/jupyter/jupyter-book/pull/53) ([choldgraf](https://github.com/choldgraf)) -- adding a default license to the book [\#48](https://github.com/jupyter/jupyter-book/pull/48) ([choldgraf](https://github.com/choldgraf)) -- fixing the internet js to not use jquery [\#47](https://github.com/jupyter/jupyter-book/pull/47) ([choldgraf](https://github.com/choldgraf)) -- Delete duplicated link in readme [\#46](https://github.com/jupyter/jupyter-book/pull/46) ([consideRatio](https://github.com/consideRatio)) -- Typo - does it matter? [\#45](https://github.com/jupyter/jupyter-book/pull/45) ([consideRatio](https://github.com/consideRatio)) -- Fix broken links [\#44](https://github.com/jupyter/jupyter-book/pull/44) ([consideRatio](https://github.com/consideRatio)) -- updating guide to latest version [\#43](https://github.com/jupyter/jupyter-book/pull/43) ([choldgraf](https://github.com/choldgraf)) -- adding tests and some more command-line options [\#41](https://github.com/jupyter/jupyter-book/pull/41) ([choldgraf](https://github.com/choldgraf)) -- Split requirements into build and run [\#36](https://github.com/jupyter/jupyter-book/pull/36) ([matthew-brett](https://github.com/matthew-brett)) -- moving notebook images folder to build [\#34](https://github.com/jupyter/jupyter-book/pull/34) ([choldgraf](https://github.com/choldgraf)) -- fixing interact link paths [\#33](https://github.com/jupyter/jupyter-book/pull/33) ([choldgraf](https://github.com/choldgraf)) -- Refactor textbook generator to check redirects [\#27](https://github.com/jupyter/jupyter-book/pull/27) ([matthew-brett](https://github.com/matthew-brett)) -- A blank target URL here would be nice. [\#15](https://github.com/jupyter/jupyter-book/pull/15) ([arokem](https://github.com/arokem)) - -# [v0.2](https://github.com/jupyter/jupyter-book/tree/v0.2) (2018-10-23) -[Full Changelog](https://github.com/jupyter/jupyter-book/compare/v0.1...v0.2) +- fixing thebelab keyboard movement [\#102](https://github.com/ExecutableBookProject/jupyter-book/pull/102) ([choldgraf](https://github.com/choldgraf)) +- Styles [\#101](https://github.com/ExecutableBookProject/jupyter-book/pull/101) ([choldgraf](https://github.com/choldgraf)) +- Update FAQ with guidelines for Plotly [\#97](https://github.com/ExecutableBookProject/jupyter-book/pull/97) ([mathieuboudreau](https://github.com/mathieuboudreau)) +- set kernelOptions for thebelab based on notebook's metadata [\#92](https://github.com/ExecutableBookProject/jupyter-book/pull/92) ([joergbrech](https://github.com/joergbrech)) +- \[WIP\] adding a CLI to generate books [\#89](https://github.com/ExecutableBookProject/jupyter-book/pull/89) ([choldgraf](https://github.com/choldgraf)) +- Fix very small typo [\#88](https://github.com/ExecutableBookProject/jupyter-book/pull/88) ([mwcraig](https://github.com/mwcraig)) +- adding update instructions [\#86](https://github.com/ExecutableBookProject/jupyter-book/pull/86) ([choldgraf](https://github.com/choldgraf)) +- adding search functionality and external links in sidebar [\#85](https://github.com/ExecutableBookProject/jupyter-book/pull/85) ([choldgraf](https://github.com/choldgraf)) +- adding codemirror theme config [\#84](https://github.com/ExecutableBookProject/jupyter-book/pull/84) ([choldgraf](https://github.com/choldgraf)) +- ignoring gh-pages for circle [\#81](https://github.com/ExecutableBookProject/jupyter-book/pull/81) ([choldgraf](https://github.com/choldgraf)) +- transferring over book to new owner [\#80](https://github.com/ExecutableBookProject/jupyter-book/pull/80) ([choldgraf](https://github.com/choldgraf)) +- sidebar logo link [\#79](https://github.com/ExecutableBookProject/jupyter-book/pull/79) ([choldgraf](https://github.com/choldgraf)) +- improve codemirror syntax highlighting [\#78](https://github.com/ExecutableBookProject/jupyter-book/pull/78) ([choldgraf](https://github.com/choldgraf)) +- updating sidebar css to be more minimal [\#76](https://github.com/ExecutableBookProject/jupyter-book/pull/76) ([choldgraf](https://github.com/choldgraf)) +- Rebuild file if source file has a newer time stamp [\#74](https://github.com/ExecutableBookProject/jupyter-book/pull/74) ([gaow](https://github.com/gaow)) +- Deploy to github.io using circle and update docs to reflect this [\#69](https://github.com/ExecutableBookProject/jupyter-book/pull/69) ([choldgraf](https://github.com/choldgraf)) +- updating requirements for binder [\#67](https://github.com/ExecutableBookProject/jupyter-book/pull/67) ([choldgraf](https://github.com/choldgraf)) +- adding thebelab buttons and some other updates [\#66](https://github.com/ExecutableBookProject/jupyter-book/pull/66) ([choldgraf](https://github.com/choldgraf)) +- adding citations support [\#64](https://github.com/ExecutableBookProject/jupyter-book/pull/64) ([choldgraf](https://github.com/choldgraf)) +- adding collapsible code blocks [\#59](https://github.com/ExecutableBookProject/jupyter-book/pull/59) ([choldgraf](https://github.com/choldgraf)) +- highlighting to right menu bar [\#58](https://github.com/ExecutableBookProject/jupyter-book/pull/58) ([choldgraf](https://github.com/choldgraf)) +- updating install instructions to use conda [\#57](https://github.com/ExecutableBookProject/jupyter-book/pull/57) ([choldgraf](https://github.com/choldgraf)) +- adding ruby to circle [\#56](https://github.com/ExecutableBookProject/jupyter-book/pull/56) ([choldgraf](https://github.com/choldgraf)) +- Make the sidebar stay on the page during scroll [\#54](https://github.com/ExecutableBookProject/jupyter-book/pull/54) ([ReventonC](https://github.com/ReventonC)) +- adding mini module and yaml splitter [\#53](https://github.com/ExecutableBookProject/jupyter-book/pull/53) ([choldgraf](https://github.com/choldgraf)) +- adding a default license to the book [\#48](https://github.com/ExecutableBookProject/jupyter-book/pull/48) ([choldgraf](https://github.com/choldgraf)) +- fixing the internet js to not use jquery [\#47](https://github.com/ExecutableBookProject/jupyter-book/pull/47) ([choldgraf](https://github.com/choldgraf)) +- Delete duplicated link in readme [\#46](https://github.com/ExecutableBookProject/jupyter-book/pull/46) ([consideRatio](https://github.com/consideRatio)) +- Typo - does it matter? [\#45](https://github.com/ExecutableBookProject/jupyter-book/pull/45) ([consideRatio](https://github.com/consideRatio)) +- Fix broken links [\#44](https://github.com/ExecutableBookProject/jupyter-book/pull/44) ([consideRatio](https://github.com/consideRatio)) +- updating guide to latest version [\#43](https://github.com/ExecutableBookProject/jupyter-book/pull/43) ([choldgraf](https://github.com/choldgraf)) +- adding tests and some more command-line options [\#41](https://github.com/ExecutableBookProject/jupyter-book/pull/41) ([choldgraf](https://github.com/choldgraf)) +- Split requirements into build and run [\#36](https://github.com/ExecutableBookProject/jupyter-book/pull/36) ([matthew-brett](https://github.com/matthew-brett)) +- moving notebook images folder to build [\#34](https://github.com/ExecutableBookProject/jupyter-book/pull/34) ([choldgraf](https://github.com/choldgraf)) +- fixing interact link paths [\#33](https://github.com/ExecutableBookProject/jupyter-book/pull/33) ([choldgraf](https://github.com/choldgraf)) +- Refactor textbook generator to check redirects [\#27](https://github.com/ExecutableBookProject/jupyter-book/pull/27) ([matthew-brett](https://github.com/matthew-brett)) +- A blank target URL here would be nice. [\#15](https://github.com/ExecutableBookProject/jupyter-book/pull/15) ([arokem](https://github.com/arokem)) + +# [v0.2](https://github.com/ExecutableBookProject/jupyter-book/tree/v0.2) (2018-10-23) +[Full Changelog](https://github.com/ExecutableBookProject/jupyter-book/compare/v0.1...v0.2) **Closed issues:** -- Feature request: Search Bar [\#25](https://github.com/jupyter/jupyter-book/issues/25) +- Feature request: Search Bar [\#25](https://github.com/ExecutableBookProject/jupyter-book/issues/25) **Merged pull requests:** -- Update to new build system [\#30](https://github.com/jupyter/jupyter-book/pull/30) ([choldgraf](https://github.com/choldgraf)) +- Update to new build system [\#30](https://github.com/ExecutableBookProject/jupyter-book/pull/30) ([choldgraf](https://github.com/choldgraf)) -# [v0.1](https://github.com/jupyter/jupyter-book/tree/v0.1) (2018-10-20) +# [v0.1](https://github.com/ExecutableBookProject/jupyter-book/tree/v0.1) (2018-10-20) **Closed issues:** -- Calling newer version of nbclean than is available on pypi [\#21](https://github.com/jupyter/jupyter-book/issues/21) -- Changing MathJax Size of only Blocks [\#19](https://github.com/jupyter/jupyter-book/issues/19) -- Change Color of Links [\#18](https://github.com/jupyter/jupyter-book/issues/18) -- Enhancements to pull from the DS100 textbook [\#17](https://github.com/jupyter/jupyter-book/issues/17) -- Hidden Code Blocks [\#13](https://github.com/jupyter/jupyter-book/issues/13) -- MathJax Rendering Issues [\#12](https://github.com/jupyter/jupyter-book/issues/12) -- Generate textbook not finding README.md [\#11](https://github.com/jupyter/jupyter-book/issues/11) -- Fork and clone may not be the best workflow [\#10](https://github.com/jupyter/jupyter-book/issues/10) +- Calling newer version of nbclean than is available on pypi [\#21](https://github.com/ExecutableBookProject/jupyter-book/issues/21) +- Changing MathJax Size of only Blocks [\#19](https://github.com/ExecutableBookProject/jupyter-book/issues/19) +- Change Color of Links [\#18](https://github.com/ExecutableBookProject/jupyter-book/issues/18) +- Enhancements to pull from the DS100 textbook [\#17](https://github.com/ExecutableBookProject/jupyter-book/issues/17) +- Hidden Code Blocks [\#13](https://github.com/ExecutableBookProject/jupyter-book/issues/13) +- MathJax Rendering Issues [\#12](https://github.com/ExecutableBookProject/jupyter-book/issues/12) +- Generate textbook not finding README.md [\#11](https://github.com/ExecutableBookProject/jupyter-book/issues/11) +- Fork and clone may not be the best workflow [\#10](https://github.com/ExecutableBookProject/jupyter-book/issues/10) **Merged pull requests:** -- Fix dollar escapes at beginning of line [\#28](https://github.com/jupyter/jupyter-book/pull/28) ([matthew-brett](https://github.com/matthew-brett)) -- Add pip requirements file [\#26](https://github.com/jupyter/jupyter-book/pull/26) ([matthew-brett](https://github.com/matthew-brett)) -- Made textbook\_folder an optional input [\#22](https://github.com/jupyter/jupyter-book/pull/22) ([jmason86](https://github.com/jmason86)) -- adding advanced section [\#16](https://github.com/jupyter/jupyter-book/pull/16) ([choldgraf](https://github.com/choldgraf)) -- adding copy buttons [\#9](https://github.com/jupyter/jupyter-book/pull/9) ([choldgraf](https://github.com/choldgraf)) -- fixing c3po [\#8](https://github.com/jupyter/jupyter-book/pull/8) ([choldgraf](https://github.com/choldgraf)) -- adding intro material [\#7](https://github.com/jupyter/jupyter-book/pull/7) ([choldgraf](https://github.com/choldgraf)) -- adding sidebar and header inferring [\#6](https://github.com/jupyter/jupyter-book/pull/6) ([choldgraf](https://github.com/choldgraf)) -- image center and max width [\#5](https://github.com/jupyter/jupyter-book/pull/5) ([choldgraf](https://github.com/choldgraf)) -- updating content width [\#4](https://github.com/jupyter/jupyter-book/pull/4) ([choldgraf](https://github.com/choldgraf)) -- stylistic improvements to textbook setting [\#3](https://github.com/jupyter/jupyter-book/pull/3) ([choldgraf](https://github.com/choldgraf)) -- updating chapter links [\#2](https://github.com/jupyter/jupyter-book/pull/2) ([choldgraf](https://github.com/choldgraf)) -- Build missing files [\#1](https://github.com/jupyter/jupyter-book/pull/1) ([choldgraf](https://github.com/choldgraf)) +- Fix dollar escapes at beginning of line [\#28](https://github.com/ExecutableBookProject/jupyter-book/pull/28) ([matthew-brett](https://github.com/matthew-brett)) +- Add pip requirements file [\#26](https://github.com/ExecutableBookProject/jupyter-book/pull/26) ([matthew-brett](https://github.com/matthew-brett)) +- Made textbook\_folder an optional input [\#22](https://github.com/ExecutableBookProject/jupyter-book/pull/22) ([jmason86](https://github.com/jmason86)) +- adding advanced section [\#16](https://github.com/ExecutableBookProject/jupyter-book/pull/16) ([choldgraf](https://github.com/choldgraf)) +- adding copy buttons [\#9](https://github.com/ExecutableBookProject/jupyter-book/pull/9) ([choldgraf](https://github.com/choldgraf)) +- fixing c3po [\#8](https://github.com/ExecutableBookProject/jupyter-book/pull/8) ([choldgraf](https://github.com/choldgraf)) +- adding intro material [\#7](https://github.com/ExecutableBookProject/jupyter-book/pull/7) ([choldgraf](https://github.com/choldgraf)) +- adding sidebar and header inferring [\#6](https://github.com/ExecutableBookProject/jupyter-book/pull/6) ([choldgraf](https://github.com/choldgraf)) +- image center and max width [\#5](https://github.com/ExecutableBookProject/jupyter-book/pull/5) ([choldgraf](https://github.com/choldgraf)) +- updating content width [\#4](https://github.com/ExecutableBookProject/jupyter-book/pull/4) ([choldgraf](https://github.com/choldgraf)) +- stylistic improvements to textbook setting [\#3](https://github.com/ExecutableBookProject/jupyter-book/pull/3) ([choldgraf](https://github.com/choldgraf)) +- updating chapter links [\#2](https://github.com/ExecutableBookProject/jupyter-book/pull/2) ([choldgraf](https://github.com/choldgraf)) +- Build missing files [\#1](https://github.com/ExecutableBookProject/jupyter-book/pull/1) ([choldgraf](https://github.com/choldgraf)) diff --git a/MAINTAINING.md b/MAINTAINING.md index bfeb6f3cc30271e4d2a3d10212785d9d8512eb18..5904881b118eaf69747cf70c0dd12eb85cd4917d 100644 --- a/MAINTAINING.md +++ b/MAINTAINING.md @@ -1,7 +1,7 @@ # The Jupyter Book maintainer's guide This is a short guide for maintaining Jupyter Book. If you're brand new to -Jupyter Book, you should probably check out the [Contributing Guide](https://github.com/jupyter/jupyter-book/blob/master/CONTRIBUTING.md) +Jupyter Book, you should probably check out the [Contributing Guide](https://github.com/ExecutableBookProject/jupyter-book/blob/master/CONTRIBUTING.md) first! ## How is this repository structured? @@ -10,15 +10,15 @@ Jupyter Book is essentially two things, both of which live in the top `jupyter_b folder: * A **book template** with HTML/CSS/structure that defines a book structure. This - lives in [`jupyter_book/jupyter_book/`](https://github.com/jupyter/jupyter-book/tree/master/jupyter_book/book_template). There is also a **minimal** folder that contains a few simple + lives in [`jupyter_book/jupyter_book/`](https://github.com/ExecutableBookProject/jupyter-book/tree/master/jupyter_book/book_template). There is also a **minimal** folder that contains a few simple content files that we use with `jupyter-book create` to pre-populate content. * A **command-line interface** that creates new books and controls machinery to do things like generate book-ready files from your notebooks. These are the Python files - in [`jupyter_book/`](https://github.com/jupyter/jupyter-book/tree/master/jupyter_book). + in [`jupyter_book/`](https://github.com/ExecutableBookProject/jupyter-book/tree/master/jupyter_book). ### Where are the tests? -Tests are located at [`jupyter_book/tests/`](https://github.com/jupyter/jupyter-book/tree/master/jupyter_book/tests). +Tests are located at [`jupyter_book/tests/`](https://github.com/ExecutableBookProject/jupyter-book/tree/master/jupyter_book/tests). They are written with **pytest**, and try to test much of the book creating and building machinery. They currently don't do a great job of testing the javascript/HTML of built books, but if you had ideas for how that could be improved, we'd really love it ✨! @@ -35,12 +35,12 @@ so the following things happen to get the docs updated: When a PR is merged into master, do the following: 1. First, run a Docker image with Python and use `jupyter-book` to build the - latest markdown files from the latest `content/` folder. ([circleci step here](https://github.com/jupyter/jupyter-book/blob/master/.circleci/config.yml#L65)). + latest markdown files from the latest `content/` folder. ([circleci step here](https://github.com/ExecutableBookProject/jupyter-book/blob/master/.circleci/config.yml#L65)). Persist the contents of the `_build/` folder with the `persist_to_workspace` command. 2. Then, run a Ruby image that loads in the `_build/` folder and builds the HTML - for the site using Jekyll. ([circleci step here](https://github.com/jupyter/jupyter-book/blob/master/.circleci/config.yml#L18)). + for the site using Jekyll. ([circleci step here](https://github.com/ExecutableBookProject/jupyter-book/blob/master/.circleci/config.yml#L18)). 3. Finally, `git push` the contents of `_site/` to the `gh-pages` branch of the repository, including a `.nojekyll` folder, and then GitHub Pages will host the updated site. -All of this is [configured in the CircleCI configuration](https://github.com/jupyter/jupyter-book/blob/master/.circleci/config.yml). +All of this is [configured in the CircleCI configuration](https://github.com/ExecutableBookProject/jupyter-book/blob/master/.circleci/config.yml). diff --git a/RELEASES.md b/RELEASES.md index c5e97585d694459b163543b876108221aa45f907..8db3c73e9254b37e59270a11166554d561c89441 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -12,16 +12,16 @@ To create a new release of Jupyter Book, you need to do these things: ## To create the release -To create a new release, [open an issue](https://github.com/jupyter/jupyter-book/issues/new) to keep +To create a new release, [open an issue](https://github.com/ExecutableBookProject/jupyter-book/issues/new) to keep track of the to-do list for the release. Copy/paste the following markdown into the issue and check off the boxes as you complete items: ``` - [ ] Ensure that there aren't any extra issues to tackle in - [the milestone for the next release](https://github.com/jupyter/jupyter-book/milestones?direction=asc&sort=due_date) + [the milestone for the next release](https://github.com/ExecutableBookProject/jupyter-book/milestones?direction=asc&sort=due_date) - [ ] Label any major bug fixes, enhancements, maintenance, and documentation improvements in the merged PRs -- [ ] Ensure that the [Jupyter Book version number](https://github.com/jupyter/jupyter-book/blob/master/jupyter_book/__init__.py) +- [ ] Ensure that the [Jupyter Book version number](https://github.com/ExecutableBookProject/jupyter-book/blob/master/jupyter_book/__init__.py) is correct, and remove the `dev0` part of the version number. Make a PR with the new number and merge into master. - [ ] Delete the extra files we don't want to include in the package, currently this is @@ -31,11 +31,11 @@ and check off the boxes as you complete items: - [ ] Create a new distribution for Jupyter Book by [following the twine release instructions](https://twine.readthedocs.io/en/latest/#using-twine) - [ ] Confirm that the new version of Jupyter Book [is posted to pypi](https://pypi.org/project/jupyter-book/) -- [ ] Create a new [release on GitHub](https://github.com/jupyter/jupyter-book/releases). +- [ ] Create a new [release on GitHub](https://github.com/ExecutableBookProject/jupyter-book/releases). Call the release simply the version of Jupyter Book you are releasing. Leave the description blank, we'll fill it in later. -- [ ] Bump the [Jupyter Book version number](https://github.com/jupyter/jupyter-book/blob/master/jupyter_book/__init__.py) to +- [ ] Bump the [Jupyter Book version number](https://github.com/ExecutableBookProject/jupyter-book/blob/master/jupyter_book/__init__.py) to the next minor (or major) release and append `dev0` to the end. - [ ] **Generate a changelog** using the `github-activity` package. @@ -47,7 +47,7 @@ and check off the boxes as you complete items: ``` * It will create a markdown changelog since the last jupyter-book release, and put it in `tmp.md`. Copy the sections about **pull requests** and add it - to [`CHANGELOG.md`](https://github.com/jupyter/jupyter-book/blob/master/CHANGELOG.md). + to [`CHANGELOG.md`](https://github.com/ExecutableBookProject/jupyter-book/blob/master/CHANGELOG.md). Ensure that the new version looks correct, then commit it to master. * Create a release summary that describes the general changes that have been made, add it to the changelog generated by `github-activity. Add this to the new section diff --git a/jupyter_book/book_template/_config.yml b/jupyter_book/book_template/_config.yml index 84bb34bdbaf2e2b95379447c0aadb41bb9c5170b..4e066ca542936d6020aca604081e6ce58f3d321e 100644 --- a/jupyter_book/book_template/_config.yml +++ b/jupyter_book/book_template/_config.yml @@ -30,7 +30,7 @@ url: "https://jupyterbook.org" # the base hostname & protocol for your site, e.g # Jupyter Book settings # Main page settings -footer_text : This page was created by <a href="https://github.com/jupyter/jupyter-book/graphs/contributors">The Jupyter Book Community</a> +footer_text : This page was created by <a href="https://github.com/ExecutableBookProject/jupyter-book/graphs/contributors">The Jupyter Book Community</a> # Sidebar settings show_sidebar : true # Show the sidebar. Only set to false if your only wish to host a single page. diff --git a/jupyter_book/book_template/_data/toc.yml b/jupyter_book/book_template/_data/toc.yml index 3ce3ce948f458d93537cd569a91b774ceb08fe0a..f74904f34cfe7d23595a5759cc8d812f4382537c 100644 --- a/jupyter_book/book_template/_data/toc.yml +++ b/jupyter_book/book_template/_data/toc.yml @@ -79,14 +79,14 @@ not_numbered: true -- url: https://github.com/jupyter/jupyter-book +- url: https://github.com/ExecutableBookProject/jupyter-book title: GitHub repository external: true not_numbered: true - url: /contributing not_numbered: true - + - title: Example Book Gallery url: /features/gallery not_numbered: true diff --git a/jupyter_book/book_template/content/beta/beta.md b/jupyter_book/book_template/content/beta/beta.md index ae5868c39296e2f384e225973c40cb10ff144d38..6ca79b33cf798819b4f99953b236723e7ff7cad3 100644 --- a/jupyter_book/book_template/content/beta/beta.md +++ b/jupyter_book/book_template/content/beta/beta.md @@ -3,4 +3,4 @@ This section contains information about upcoming (and potentially changing) features that still haven't solidified and should be treated as experimental. If you've got any thoughts about them, please do -[open an issue about it](https://github.com/jupyter/jupyter-book/issues/new). +[open an issue about it](https://github.com/ExecutableBookProject/jupyter-book/issues/new). diff --git a/jupyter_book/book_template/content/contributing.md b/jupyter_book/book_template/content/contributing.md index 7f2d72dbb5809a9d201f85c9a3cd304ba79c02f5..ae1095c6e7302ab8cb49b16b0c948da7049a4482 100644 --- a/jupyter_book/book_template/content/contributing.md +++ b/jupyter_book/book_template/content/contributing.md @@ -77,7 +77,7 @@ The current list of labels are [here][link_labels] and include: ## Repository Structure of Jupyter Book This section covers the general structure of the -[Jupyter Book repository](https://github.com/jupyter/jupyter-book), and +[Jupyter Book repository](https://github.com/ExecutableBookProject/jupyter-book), and explains which pieces are where. The Jupyter Book repository contains two main pieces: @@ -85,11 +85,11 @@ The Jupyter Book repository contains two main pieces: ### The command-line tool and Python package This is used to help create and build books. -It can be found at [`./jupyter_book`](https://github.com/jupyter/jupyter-book/tree/master/jupyter_book). +It can be found at [`./jupyter_book`](https://github.com/ExecutableBookProject/jupyter-book/tree/master/jupyter_book). * **The `page` module builds single pages**. This module is meant to be self-contained for converting single `.ipynb`/`.md`/etc pages into HTML. Jupyter Book uses this module when building entire books, but the module can also be used on its own (it's what `jupyter-book page` uses). - You can find the module at: [`jupyter_book/page`](https://github.com/jupyter/jupyter-book/tree/master/jupyter_book/page). + You can find the module at: [`jupyter_book/page`](https://github.com/ExecutableBookProject/jupyter-book/tree/master/jupyter_book/page). * **The `create.py` and `build.py` create and build a book**. They connect with the CLI and are used to process multiple pages and stitch them together into a static website template. @@ -98,20 +98,20 @@ It can be found at [`./jupyter_book`](https://github.com/jupyter/jupyter-book/tr This is used when generating new books. This website defines the structure of the site that is created when you run `jupyter-book create`. It contains the Javascript, CSS, and HTML structure of a book. It can be found at -[`jupyter_book/book_template`](https://github.com/jupyter/jupyter-book/tree/master/jupyter_book/book_template). -* The [`_includes/`](https://github.com/jupyter/jupyter-book/tree/master/jupyter_book/book_template/_includes) +[`jupyter_book/book_template`](https://github.com/ExecutableBookProject/jupyter-book/tree/master/jupyter_book/book_template). +* The [`_includes/`](https://github.com/ExecutableBookProject/jupyter-book/tree/master/jupyter_book/book_template/_includes) folder contains core HTML and javascript files for the site. For example, - [`_includes/head.html`](https://github.com/jupyter/jupyter-book/blob/master/jupyter_book/book_template/_includes/head.html) contains the HTML for the header of each page, which is where CSS and JS files are linked. -* The [`assets/`](https://github.com/jupyter/jupyter-book/tree/master/jupyter_book/book_template/assets) + [`_includes/head.html`](https://github.com/ExecutableBookProject/jupyter-book/blob/master/jupyter_book/book_template/_includes/head.html) contains the HTML for the header of each page, which is where CSS and JS files are linked. +* The [`assets/`](https://github.com/ExecutableBookProject/jupyter-book/tree/master/jupyter_book/book_template/assets) folder contains static CSS/JS files that don't depend on site configuration. -* The [`_sass/`](https://github.com/jupyter/jupyter-book/tree/master/jupyter_book/book_template/_sass) +* The [`_sass/`](https://github.com/ExecutableBookProject/jupyter-book/tree/master/jupyter_book/book_template/_sass) folder contains all of the book and page CSS rules. This is stitched together in a single CSS file at build time (SCSS is a way to split up CSS rules among multiple files). Within this folder, the - [`_sass/page/`](https://github.com/jupyter/jupyter-book/tree/master/jupyter_book/book_template/_sass/page) folder + [`_sass/page/`](https://github.com/ExecutableBookProject/jupyter-book/tree/master/jupyter_book/book_template/_sass/page) folder has CSS files for a single page of content, while the other folders/files contain CSS rules for the whole book. -* The [`content/`](https://github.com/jupyter/jupyter-book/tree/master/jupyter_book/book_template/content) - folder contains the content for the Jupyter Book documentation (e.g., the [markdown for this page](https://github.com/jupyter/jupyter-book/tree/master/jupyter_book/book_template/content/contributing.md)). +* The [`content/`](https://github.com/ExecutableBookProject/jupyter-book/tree/master/jupyter_book/book_template/content) + folder contains the content for the Jupyter Book documentation (e.g., the [markdown for this page](https://github.com/ExecutableBookProject/jupyter-book/tree/master/jupyter_book/book_template/content/contributing.md)). ### An example @@ -122,7 +122,7 @@ Here are a few examples of how this code gets used to help you get started. and uses the `page/` module to convert each one into HTML and places it in `mybook/_build`. Hopefully this explanation gets you situated and helps you understand how the pieces all fit together. -If you have any questions, feel free to [open an issue asking for help](https://github.com/jupyter/jupyter-book/issues/new)! +If you have any questions, feel free to [open an issue asking for help](https://github.com/ExecutableBookProject/jupyter-book/issues/new)! ## Making a change @@ -194,7 +194,7 @@ You're awesome. [link_git]: https://git-scm.com [link_github]: https://github.com/https://github.com/jupyter/governance/blob/master/conduct/code_of_conduct.md -[link_jupyter-book]: https://github.com/jupyter/jupyter-book +[link_jupyter-book]: https://github.com/ExecutableBookProject/jupyter-book [link_signupinstructions]: https://help.github.com/articles/signing-up-for-a-new-github-account [writing_formatting_github]: https://help.github.com/articles/getting-started-with-writing-and-formatting-on-github @@ -204,14 +204,14 @@ You're awesome. [sphinx]: http://www.sphinx-doc.org/en/master/index.html [readthedocs]: https://docs.readthedocs.io/en/latest/index.html -[link_issues]: https://github.com/jupyter/jupyter-book/issues +[link_issues]: https://github.com/ExecutableBookProject/jupyter-book/issues [link_coc]: https://github.com/jupyter/governance/blob/master/conduct/code_of_conduct.md -[link_labels]: https://github.com/jupyter/jupyter-book/labels -[link_bugs]: https://github.com/jupyter/jupyter-book/labels/bug -[link_helpwanted]: https://github.com/jupyter/jupyter-book/labels/help%20wanted -[link_enhancement]: https://github.com/jupyter/jupyter-book/labels/enhancement -[link_question]: https://github.com/jupyter/jupyter-book/labels/question +[link_labels]: https://github.com/ExecutableBookProject/jupyter-book/labels +[link_bugs]: https://github.com/ExecutableBookProject/jupyter-book/labels/bug +[link_helpwanted]: https://github.com/ExecutableBookProject/jupyter-book/labels/help%20wanted +[link_enhancement]: https://github.com/ExecutableBookProject/jupyter-book/labels/enhancement +[link_question]: https://github.com/ExecutableBookProject/jupyter-book/labels/question [link_pullrequest]: https://help.github.com/articles/creating-a-pull-request/ [link_fork]: https://help.github.com/articles/fork-a-repo/ @@ -221,5 +221,5 @@ You're awesome. [link_drafts]: https://help.github.com/articles/about-pull-requests/#draft-pull-requests -[link_contributors]: https://github.com/jupyter/jupyter-book/graphs/contributors +[link_contributors]: https://github.com/ExecutableBookProject/jupyter-book/graphs/contributors [link_stemmrolemodels]: https://github.com/KirstieJane/STEMMRoleModels diff --git a/jupyter_book/book_template/content/features/beta.md b/jupyter_book/book_template/content/features/beta.md index 450203c891114c11604360172f8bfd4fe97fcecd..63914c6d8de576f9601126354963b54ed501700f 100644 --- a/jupyter_book/book_template/content/features/beta.md +++ b/jupyter_book/book_template/content/features/beta.md @@ -3,4 +3,4 @@ The following features are all labeled as **beta**, this means that they might evolve, change, or even be removed entirely. Your feedback is encouraged on these pieces of Jupyter Book, as their form and function is still being worked -out. If you have any suggestions or ideas, please [open an issue](https://github.com/jupyter/jupyter-book/issues/new). \ No newline at end of file +out. If you have any suggestions or ideas, please [open an issue](https://github.com/ExecutableBookProject/jupyter-book/issues/new). \ No newline at end of file diff --git a/jupyter_book/book_template/content/features/gallery.ipynb b/jupyter_book/book_template/content/features/gallery.ipynb index 06ef05a5e33dd2be0d0aa05131cec22ba6583390..24fd67322f07fcbb293ff7a417dd8ec8440b0dd5 100644 --- a/jupyter_book/book_template/content/features/gallery.ipynb +++ b/jupyter_book/book_template/content/features/gallery.ipynb @@ -7,10 +7,10 @@ "# A gallery of Jupyter Books\n", "\n", "Below is small gallery of Jupyter Books in the wild. They have been semi-randomly selected\n", - "from [the list of GitHub projects that depend on Jupyter Book](https://github.com/jupyter/jupyter-book/network/dependents?package_id=UGFja2FnZS0zMjg0ODMyNzQ%3D).\n", + "from [the list of GitHub projects that depend on Jupyter Book](https://github.com/ExecutableBookProject/jupyter-book/network/dependents?package_id=UGFja2FnZS0zMjg0ODMyNzQ%3D).\n", "\n", "If you'd like to add your book to the list, you may submit a pull request adding\n", - "your book's information to [this YAML file of demo example books](https://github.com/jupyter/jupyter-book/blob/master/jupyter_book/book_template/content/data/gallery.yml)." + "your book's information to [this YAML file of demo example books](https://github.com/ExecutableBookProject/jupyter-book/blob/master/jupyter_book/book_template/content/data/gallery.yml)." ] }, { diff --git a/jupyter_book/book_template/content/features/jupytext.md b/jupyter_book/book_template/content/features/jupytext.md index a24a7c3f408b6369e2aaaa4e62ca6c97e9114ffc..482c276d66376e77ae56e6ef61b56c642d58365a 100644 --- a/jupyter_book/book_template/content/features/jupytext.md +++ b/jupyter_book/book_template/content/features/jupytext.md @@ -27,7 +27,7 @@ your files, which means building your book with outputs requires running each fi ## This notebook is stored in Jupytext format! For example, the notebook for this page is stored in a Jupytext format. In this case, we've used -a markdown file. [You can find the original (text-based) format here](https://github.com/jupyter/jupyter-book/blob/master/jupyter_book/book_template/content/features/jupytext.md). +a markdown file. [You can find the original (text-based) format here](https://github.com/ExecutableBookProject/jupyter-book/blob/master/jupyter_book/book_template/content/features/jupytext.md). Below we'll show some Python code, which Jupyter Book can execute at build time. diff --git a/jupyter_book/book_template/content/features/markdown.md b/jupyter_book/book_template/content/features/markdown.md index bc15a0527bc7e016c99c99f33d4a366c71ce34b5..cbc20c1ec25b088e8ee186774ce139532ec72098 100644 --- a/jupyter_book/book_template/content/features/markdown.md +++ b/jupyter_book/book_template/content/features/markdown.md @@ -76,7 +76,7 @@ P(A_1 \cup A_2 \cup A_3) ~ = ~ P(B \cup A_3) &= ~ P(B) + P(A_3) - P(BA_3) \\ **Note**: If you print your page (using the print button), then mathematics may not show up properly in an output PDF. This is because MathJax isn't able to render the math before converting to PDF. If you have a good idea for how to get around this, please do -[open an issue](https://github.com/jupyter/jupyter-book/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc)! +[open an issue](https://github.com/ExecutableBookProject/jupyter-book/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc)! <!-- #endregion --> ## Embedding media diff --git a/jupyter_book/book_template/content/features/notebooks.ipynb b/jupyter_book/book_template/content/features/notebooks.ipynb index 9844d4ef74ce026f3c70504daef16e6dd9e78c6e..704833a5c003441251eb75e8ba2c8a870ed72e25 100644 --- a/jupyter_book/book_template/content/features/notebooks.ipynb +++ b/jupyter_book/book_template/content/features/notebooks.ipynb @@ -10,7 +10,7 @@ "in a Jupyter Notebook in the `notebooks/` folder of the repository. This means that we can include\n", "code blocks and their outputs, and export them to Jekyll markdown.\n", "\n", - "**You can find the original notebook for this page [at this address](https://github.com/jupyter/jupyter-book/blob/master/jupyter_book/book_template/content/features/notebooks.ipynb)**\n", + "**You can find the original notebook for this page [at this address](https://github.com/ExecutableBookProject/jupyter-book/blob/master/jupyter_book/book_template/content/features/notebooks.ipynb)**\n", "\n", "## Markdown + notebooks\n", "\n", @@ -163,7 +163,7 @@ "## Removing content before publishing\n", "\n", "You can also remove some content before publishing your book to the web. For example,\n", - "in [the original notebook](https://github.com/jupyter/jupyter-book/blob/master/jupyter_book/book_template/content/features/notebooks.ipynb) there\n", + "in [the original notebook](https://github.com/ExecutableBookProject/jupyter-book/blob/master/jupyter_book/book_template/content/features/notebooks.ipynb) there\n", "used to be a cell below..." ] }, @@ -205,7 +205,7 @@ "You can also **remove only the code** so that images and other output still show up.\n", "\n", "Below we'll *only* display an image. It was generated with Python code in a cell,\n", - "which you can [see in the original notebook](https://github.com/jupyter/jupyter-book/blob/master/jupyter_book/book_template/content/features/notebooks.ipynb)" + "which you can [see in the original notebook](https://github.com/ExecutableBookProject/jupyter-book/blob/master/jupyter_book/book_template/content/features/notebooks.ipynb)" ] }, { diff --git a/jupyter_book/book_template/content/guide/05_faq.md b/jupyter_book/book_template/content/guide/05_faq.md index 1f6891d113935aed036c13b59d76a6b6adcebe19..7bb367fd65ca7f3bd18962028ca9f6a5b80d2a10 100644 --- a/jupyter_book/book_template/content/guide/05_faq.md +++ b/jupyter_book/book_template/content/guide/05_faq.md @@ -50,7 +50,7 @@ This should reset the state of the folder to the last commit in your git history ## Does the book behave differently depending on the browser? Maybe - Jupyter Book does use some features that might have different behaviors in -some browsers. For example, Safari [tends to treat downloadable objects](https://github.com/jupyter/jupyter-book/pull/104#issuecomment-462461188) +some browsers. For example, Safari [tends to treat downloadable objects](https://github.com/ExecutableBookProject/jupyter-book/pull/104#issuecomment-462461188) differently for some reason. The two browsers on which Jupyter Book should always behave as expected are @@ -92,7 +92,7 @@ Note that, if viewing the file on a Jupyter Notebook session, the figure will no ## What if I have an issue or question? If you've got questions, concerns, or suggestions, please open an issue at -[at the jupyter book issues page](https://github.com/jupyter/jupyter-book/issues) +[at the jupyter book issues page](https://github.com/ExecutableBookProject/jupyter-book/issues) ## How should I add cell tags to my notebooks? @@ -140,7 +140,7 @@ same fonts available when you're viewing a page live. This means that mathematic look simplified and incorrectly-formatted. If you have an idea for how to improve this, please -[open an issue](https://github.com/jupyter/jupyter-book/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc)! +[open an issue](https://github.com/ExecutableBookProject/jupyter-book/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc)! ## What is this `Gemfile.lock` file or why am I getting Jekyll dependency warnings? diff --git a/jupyter_book/book_template/content/guide/06_advanced.md b/jupyter_book/book_template/content/guide/06_advanced.md index 905dfaee81c5c86303d67242c3918c2f80bff3f7..fe43c94d23a9b0c8db1a53b21fb46ba6ab798428 100644 --- a/jupyter_book/book_template/content/guide/06_advanced.md +++ b/jupyter_book/book_template/content/guide/06_advanced.md @@ -1,7 +1,7 @@ # Advanced topics and how-tos This page contains more advanced and complete information about the -[`jupyter-book` repository](https://github.com/jupyter/jupyter-book). See the sections below. +[`jupyter-book` repository](https://github.com/ExecutableBookProject/jupyter-book). See the sections below. ## Enable Google Analytics @@ -174,10 +174,10 @@ check out these resources: * **[This blog post on pushing changes from a CircleCI Job](https://predictablynoisy.com/circleci-mirror)** covers how you can give CircleCI permissions to push to a branch from within a job. -* **[The Jupyter Book CircleCI configuration file](https://github.com/jupyter/jupyter-book/blob/master/.circleci/config.yml)** +* **[The Jupyter Book CircleCI configuration file](https://github.com/ExecutableBookProject/jupyter-book/blob/master/.circleci/config.yml)** automatically deploys changes to the `jupyter-book` master branch to the live book. In - particular, [this section builds the book HTML files](https://github.com/jupyter/jupyter-book/blob/master/.circleci/config.yml#L74) - while [this section builds the HTML and pushes them to a `gh-pages` branch](https://github.com/jupyter/jupyter-book/blob/master/.circleci/config.yml#L31). + particular, [this section builds the book HTML files](https://github.com/ExecutableBookProject/jupyter-book/blob/master/.circleci/config.yml#L74) + while [this section builds the HTML and pushes them to a `gh-pages` branch](https://github.com/ExecutableBookProject/jupyter-book/blob/master/.circleci/config.yml#L31). This process can be tricky to set up initially, but is quite useful in ensuring that your live book always stays up-to-date. diff --git a/jupyter_book/book_template/content/guide/publish/book-html.md b/jupyter_book/book_template/content/guide/publish/book-html.md index 27f3c36e39437449893ba4803aabe5b4de0ee837..472742fe6e248e065cb90aa4309526e0b61a78c7 100644 --- a/jupyter_book/book_template/content/guide/publish/book-html.md +++ b/jupyter_book/book_template/content/guide/publish/book-html.md @@ -22,7 +22,7 @@ In order to locally build your book's HTML with Jekyll, you'll take one of two a 1. Install a copy of the Ruby language (which is a free open-source language, but can be a pain to install). 2. Use a container software (Docker or Singularity) along with a Docker image that we've prepared for you - [from this Dockerfile](https://github.com/jupyter/jupyter-book/blob/master/jupyter_book/Dockerfile). + [from this Dockerfile](https://github.com/ExecutableBookProject/jupyter-book/blob/master/jupyter_book/Dockerfile). We recommend installing Ruby with one of the supplied methods first, and if this fails, try installing with a container tool such as Docker. diff --git a/jupyter_book/book_template/content/intro.ipynb b/jupyter_book/book_template/content/intro.ipynb index 29c55bcda9189591f647c8e6fe6b69b27cd20678..dbb920014c226b02c58b67fdb256cb731f1fbd92 100644 --- a/jupyter_book/book_template/content/intro.ipynb +++ b/jupyter_book/book_template/content/intro.ipynb @@ -55,7 +55,7 @@ "source": [ "## Getting started\n", "\n", - "*This documentation is for the [master branch of Jupyter Book](https://github.com/jupyter/jupyter-book), which\n", + "*This documentation is for the [master branch of Jupyter Book](https://github.com/ExecutableBookProject/jupyter-book), which\n", "means that it might be slightly out-of-date with the\n", "[latest version released](https://pypi.org/project/jupyter-book/) on pip*.\n", "\n", @@ -79,7 +79,7 @@ "you can run:\n", "\n", "```\n", - "pip install git+https://github.com/jupyter/jupyter-book\n", + "pip install git+https://github.com/ExecutableBookProject/jupyter-book\n", "```\n", "\n", "This will install the *master branch* of Jupyter Book (what these docs are\n", diff --git a/jupyter_book/minimal/_data/toc.yml b/jupyter_book/minimal/_data/toc.yml index 448207da4f94773887ded3b07c9bd32f83ccc1d1..b0ec56e5890faaeb483d35db33a44beb0c00a957 100644 --- a/jupyter_book/minimal/_data/toc.yml +++ b/jupyter_book/minimal/_data/toc.yml @@ -28,7 +28,7 @@ # External link - title: GitHub repository - url: https://github.com/jupyter/jupyter-book + url: https://github.com/ExecutableBookProject/jupyter-book external: true not_numbered: true diff --git a/jupyter_book/minimal/content/features/notebooks.ipynb b/jupyter_book/minimal/content/features/notebooks.ipynb index 0b49b1081792543185a11ae9b34bfb097c4b6869..080f2f6be80ae3e06a26154e40d5c8bcddcc3f72 100644 --- a/jupyter_book/minimal/content/features/notebooks.ipynb +++ b/jupyter_book/minimal/content/features/notebooks.ipynb @@ -10,7 +10,7 @@ "in a Jupyter Notebook in the `notebooks/` folder of the repository. This means that we can include\n", "code blocks and their outputs, and export them to Jekyll markdown.\n", "\n", - "**You can find the original notebook for this page [at this address](https://github.com/jupyter/jupyter-book/blob/master/jupyter_book/minimal/content/features/notebooks.ipynb)**\n", + "**You can find the original notebook for this page [at this address](https://github.com/ExecutableBookProject/jupyter-book/blob/master/jupyter_book/minimal/content/features/notebooks.ipynb)**\n", "\n", "## Markdown + notebooks\n", "\n", @@ -104,7 +104,7 @@ "## Removing content before publishing\n", "\n", "You can also remove some content before publishing your book to the web. For example,\n", - "in [the original notebook](https://github.com/jupyter/jupyter-book/blob/master/jupyter_book/minimal/content/features/notebooks.ipynb) there\n", + "in [the original notebook](https://github.com/ExecutableBookProject/jupyter-book/blob/master/jupyter_book/minimal/content/features/notebooks.ipynb) there\n", "used to be a cell below..." ] }, @@ -142,7 +142,7 @@ "You can also **remove only the code** so that images and other output still show up.\n", "\n", "Below we'll *only* display an image. It was generated with Python code in a cell,\n", - "which you can [see in the original notebook](https://github.com/jupyter/jupyter-book/blob/master/jupyter_book/minimal/content/features/notebooks.ipynb)" + "which you can [see in the original notebook](https://github.com/ExecutableBookProject/jupyter-book/blob/master/jupyter_book/minimal/content/features/notebooks.ipynb)" ] }, { @@ -178,7 +178,7 @@ "metadata": {}, "source": [ "And here we'll *only* display a Pandas DataFrame. Again, this was generated with Python code\n", - "from [this original notebook](https://github.com/jupyter/jupyter-book/blob/master/jupyter_book/minimal/content/features/notebooks.ipynb)." + "from [this original notebook](https://github.com/ExecutableBookProject/jupyter-book/blob/master/jupyter_book/minimal/content/features/notebooks.ipynb)." ] }, { diff --git a/jupyter_book/minimal/content/intro.md b/jupyter_book/minimal/content/intro.md index 059cf68cf9aeaef64992add39c0ddee77e3262ff..520905833081b0dfeb008be16f01410682e88a1f 100644 --- a/jupyter_book/minimal/content/intro.md +++ b/jupyter_book/minimal/content/intro.md @@ -27,7 +27,7 @@ Here are a few links of interest: * **[The Jupyter Book Guide](guide/01_overview)** will step you through the process of configuring and building your own Jupyter Book. -* **[The Jupyter Book template repo](https://github.com/jupyter/jupyter-book)** is the template +* **[The Jupyter Book template repo](https://github.com/ExecutableBookProject/jupyter-book)** is the template repository you'll use as a start for your Jupyter Book. * **A demo of the Jupyter Book** can be browsed via the sidebar to the left. diff --git a/jupyter_book/tests/site/content/root_test.md b/jupyter_book/tests/site/content/root_test.md index 1d17a366a4ae7a992659600efd003e9a7d9c0978..72626dc034ebc5917c0955f7a62cde7be425a079 100644 --- a/jupyter_book/tests/site/content/root_test.md +++ b/jupyter_book/tests/site/content/root_test.md @@ -24,7 +24,7 @@ Here are a few links of interest: * **[The Jupyter Book Guide](ch/guide/00_intro)** will step you through the process of configuring and building your own Jupyter Book. -* **[The Jupyter Book template repo](https://github.com/jupyter/jupyter-book)** is the template +* **[The Jupyter Book template repo](https://github.com/ExecutableBookProject/jupyter-book)** is the template repository you'll use as a start for your Jupyter Book. * **A demo of the Jupyter Book** can be browsed via the sidebar to the left. diff --git a/jupyter_book/tests/site/content/tests/jupytext/jupytext_Rmd.Rmd b/jupyter_book/tests/site/content/tests/jupytext/jupytext_Rmd.Rmd index 155386ed1ff0a0ad0b806a5fc5801654bf717852..da1e196dc84be0e1b7c4bbbefcec4748d0b096cd 100644 --- a/jupyter_book/tests/site/content/tests/jupytext/jupytext_Rmd.Rmd +++ b/jupyter_book/tests/site/content/tests/jupytext/jupytext_Rmd.Rmd @@ -25,7 +25,7 @@ your files, which means building your book with outputs requires running each fi ## This notebook is stored in Jupytext format! For example, the notebook for this page is stored in a Jupytext format. In this case, we've used -a markdown file. [You can find the original (text-based) format here](https://github.com/jupyter/jupyter-book/blob/master/jupyter_book/book_template/content/features/jupytext.md). +a markdown file. [You can find the original (text-based) format here](https://github.com/ExecutableBookProject/jupyter-book/blob/master/jupyter_book/book_template/content/features/jupytext.md). Below we'll show some Python code, which Jupyter Book can execute at build time. diff --git a/jupyter_book/tests/site/content/tests/jupytext/jupytext_ipynb.ipynb b/jupyter_book/tests/site/content/tests/jupytext/jupytext_ipynb.ipynb index 6d04ff7a2922260d4b8d7463ad2003c19d091b56..9840678608577b9d49f278fae05b9ded45043bad 100644 --- a/jupyter_book/tests/site/content/tests/jupytext/jupytext_ipynb.ipynb +++ b/jupyter_book/tests/site/content/tests/jupytext/jupytext_ipynb.ipynb @@ -16,7 +16,7 @@ "## This notebook is stored in Jupytext format!\n", "\n", "For example, the notebook for this page is stored in a Jupytext format. In this case, we've used\n", - "a markdown file. [You can find the original (text-based) format here](https://github.com/jupyter/jupyter-book/blob/master/jupyter_book/book_template/content/features/jupytext.md).\n", + "a markdown file. [You can find the original (text-based) format here](https://github.com/ExecutableBookProject/jupyter-book/blob/master/jupyter_book/book_template/content/features/jupytext.md).\n", "\n", "Below we'll show some Python code, which Jupyter Book can execute at build time." ] diff --git a/jupyter_book/tests/site/content/tests/jupytext/jupytext_md.md b/jupyter_book/tests/site/content/tests/jupytext/jupytext_md.md index 0554024603119e94aef4e75ccbf86697d3642600..59563dcc9f34f3dd8d3bb05201691dd9d8c9c4a6 100644 --- a/jupyter_book/tests/site/content/tests/jupytext/jupytext_md.md +++ b/jupyter_book/tests/site/content/tests/jupytext/jupytext_md.md @@ -25,7 +25,7 @@ your files, which means building your book with outputs requires running each fi ## This notebook is stored in Jupytext format! For example, the notebook for this page is stored in a Jupytext format. In this case, we've used -a markdown file. [You can find the original (text-based) format here](https://github.com/jupyter/jupyter-book/blob/master/jupyter_book/book_template/content/features/jupytext.md). +a markdown file. [You can find the original (text-based) format here](https://github.com/ExecutableBookProject/jupyter-book/blob/master/jupyter_book/book_template/content/features/jupytext.md). Below we'll show some Python code, which Jupyter Book can execute at build time. diff --git a/jupyter_book/tests/site/content/tests/jupytext/jupytext_py.py b/jupyter_book/tests/site/content/tests/jupytext/jupytext_py.py index bb2e595a4ae40bc2c1bd81cab9d4ffaa228bc8ac..56d4e5927a3cec7d09a77aea11f1142ffc79dbae 100644 --- a/jupyter_book/tests/site/content/tests/jupytext/jupytext_py.py +++ b/jupyter_book/tests/site/content/tests/jupytext/jupytext_py.py @@ -26,7 +26,7 @@ # ## This notebook is stored in Jupytext format! # # For example, the notebook for this page is stored in a Jupytext format. In this case, we've used -# a markdown file. [You can find the original (text-based) format here](https://github.com/jupyter/jupyter-book/blob/master/jupyter_book/book_template/content/features/jupytext.md). +# a markdown file. [You can find the original (text-based) format here](https://github.com/ExecutableBookProject/jupyter-book/blob/master/jupyter_book/book_template/content/features/jupytext.md). # # Below we'll show some Python code, which Jupyter Book can execute at build time. diff --git a/jupyter_book/tests/site/content/tests/notebooks.ipynb b/jupyter_book/tests/site/content/tests/notebooks.ipynb index bd6322471cabfed16baf1ae62299d29da7ab97f9..d6ebe17b08ad69369b1468aa53eacf69b018e9d6 100644 --- a/jupyter_book/tests/site/content/tests/notebooks.ipynb +++ b/jupyter_book/tests/site/content/tests/notebooks.ipynb @@ -153,7 +153,7 @@ "## Removing content before publishing\n", "\n", "You can also remove some content before publishing your book to the web. For example,\n", - "in [the original notebook](https://github.com/jupyter/jupyter-book/blob/master/notebooks/introduction/notebooks.ipynb) there\n", + "in [the original notebook](https://github.com/ExecutableBookProject/jupyter-book/blob/master/notebooks/introduction/notebooks.ipynb) there\n", "used to be a cell below..." ] }, @@ -195,7 +195,7 @@ "You can also **remove only the code** so that images and other output still show up.\n", "\n", "Below we'll *only* display an image. It was generated with Python code in a cell,\n", - "which you can [see in the original notebook](https://github.com/jupyter/jupyter-book/blob/master/notebooks/introduction/notebooks.ipynb)" + "which you can [see in the original notebook](https://github.com/ExecutableBookProject/jupyter-book/blob/master/notebooks/introduction/notebooks.ipynb)" ] }, { @@ -234,7 +234,7 @@ "metadata": {}, "source": [ "And here we'll *only* display a Pandas DataFrame. Again, this was generated with Python code\n", - "from [this original notebook](https://github.com/jupyter/jupyter-book/blob/master/notebooks/introduction/notebooks.ipynb)." + "from [this original notebook](https://github.com/ExecutableBookProject/jupyter-book/blob/master/notebooks/introduction/notebooks.ipynb)." ] }, { diff --git a/netlify.toml b/netlify.toml index 464f0471d1031daae2f6e5de6b1ab8ff0edb3f66..f42c8b4cfa4dd702bfa354be7fb05e3917f6d059 100644 --- a/netlify.toml +++ b/netlify.toml @@ -1,5 +1,5 @@ [build] - command = "gem install bundler -v '2.0.2' && pip install -U git+https://github.com/jupyter/jupyter-book && jupyter-book build ./ --overwrite && jupyter-book page ./content/features/notebooks.ipynb -o _build && bundle exec jekyll build" + command = "gem install bundler -v '2.0.2' && pip install -U git+https://github.com/ExecutableBookProject/jupyter-book && jupyter-book build ./ --overwrite && jupyter-book page ./content/features/notebooks.ipynb -o _build && bundle exec jekyll build" [context.deploy-preview] command = "gem install bundler -v '2.0.2' && pip install -e ../../ && jupyter-book build ./ --overwrite && jupyter-book page ./content/features/notebooks.ipynb -o _build && bundle exec jekyll build" \ No newline at end of file diff --git a/setup.py b/setup.py index fc6688bbc8dd1468e36ba9f9b6a69ad5f6a48f19..874062995e4fe91c826b17d2594155ab85dca2bc 100644 --- a/setup.py +++ b/setup.py @@ -31,8 +31,8 @@ setup( project_urls={ 'Documentation': 'https://jupyterbook.org', 'Funding': 'https://jupyter.org/about', - 'Source': 'https://github.com/jupyter/jupyter-book/', - 'Tracker': 'https://github.com/jupyter/jupyter-book/issues', + 'Source': 'https://github.com/ExecutableBookProject/jupyter-book/', + 'Tracker': 'https://github.com/ExecutableBookProject/jupyter-book/issues', }, # this should be a whitespace separated string of keywords, not a list keywords="reproducible science environments scholarship notebook",