From 7c3835b1fb386047be500107d1029ccc4929bbc4 Mon Sep 17 00:00:00 2001 From: mmcky <mmcky@users.noreply.github.com> Date: Tue, 22 Dec 2020 10:52:48 +1100 Subject: [PATCH] =?UTF-8?q?=F0=9F=9A=80=20RELEASE:=20v0.9.0=20(#1129)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * RELEASE: v0.9.0 --- CHANGELOG.md | 43 ++++++++++++++++++++++++++++++++++++++++ RELEASES.md | 40 ------------------------------------- jupyter_book/__init__.py | 2 +- 3 files changed, 44 insertions(+), 41 deletions(-) delete mode 100644 RELEASES.md diff --git a/CHANGELOG.md b/CHANGELOG.md index 058546e8..f6d73f23 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,48 @@ # Change Log +## v0.9.0 2020-12-09 + +([full changelog](https://github.com/executablebooks/jupyter-book/compare/v0.8.3...6c30f554d86fe7d1a0e4ad05012a5de4133117d0)) + +This release includes a number of new features, improvements and bug fixes. There is also a new [gallery of jupyter-book projects](https://executablebooks.org/en/latest/gallery.html) available. + +### New + +* 👌 IMPROVE: Option to exclude every file not in the toc. ([docs](docs/customize/config.md), [#1123](https://github.com/executablebooks/jupyter-book/pull/1123), [@alex-treebeard](https://github.com/alex-treebeard)) +* ✨ NEW: Enable the use of local Sphinx extension via _config.yml. ([docs](docs/customize/config.md), [#1102](https://github.com/executablebooks/jupyter-book/pull/1102), [@mmcky](https://github.com/mmcky)) +* ✨ NEW: Enable custom builder passthrough. This is an **advanced feature** + that enables the use of additional sphinx builders via jupyter-book that may be provided by an extension. ([docs](docs/advanced/advanced.md), [#1094]([#1094](https://github.com/executablebooks/jupyter-book/pull/1094)), [@mmcky](https://github.com/mmcky)) + +**HTML:** + +* 👌 NEW: Add `dirhtml` builder. This enables the use + of the `dirhtml` sphinx builder when using jupyter book. ([docs](docs/start/build.md), [#1092](https://github.com/executablebooks/jupyter-book/pull/1092), [@choldgraf](https://github.com/choldgraf)) + +**LaTeX:** + +* ✨ NEW: Add `--individualpages` option for pdflatex builder. + This option enables building individual (pdflatex) files for each page of the project. **Note:** Further work is ongoing to improve the styling and formatting of pdflatex output. + ([docs](docs/advanced/pdf.md), [#944](https://github.com/executablebooks/jupyter-book/pull/944), [@mmcky](https://github.com/mmcky)) + +### Maintain + +* 🔧 MAINTAIN: Pin sphinxcontrib-bibtex to ~=1.0 until compatible with recently released v2 ([#1138](https://github.com/executablebooks/jupyter-book/pull/1138), [@choldgraf](https://github.com/choldgraf)) + +### Upgrades + +* ⬆ UPGRADE: sphinx-book-theme v0.0.39 ([#1086](https://github.com/executablebooks/jupyter-book/pull/1086), [@choldgraf](https://github.com/choldgraf)) + +### Bugs fixed + +* 🛠FIX: Check for file extensions when generating toc. ([#1108](https://github.com/executablebooks/jupyter-book/pull/1108), [@AakashGfude](https://github.com/AakashGfude)) +* 🛠FIX: Export Notebook as HTML with no page-breaks. ([#903](https://github.com/executablebooks/jupyter-book/pull/903), [@AakashGfude](https://github.com/AakashGfude)) +* 🛠FIX: Restore linkcheck to builder opts ([#1051](https://github.com/executablebooks/jupyter-book/pull/1051), [@fmaussion](https://github.com/fmaussion)) + +### Deprecated + +* 🗑 DEPRECATE: removing expand_sections for toc as it is deprecated in `sphinx-book-theme`. ([#1073](https://github.com/executablebooks/jupyter-book/pull/1073), [@choldgraf](https://github.com/choldgraf)) + + ## v0.8.3 2020-10-12 This is a relatively minor release with bugfixes and under-the-hood improvements. diff --git a/RELEASES.md b/RELEASES.md deleted file mode 100644 index ef370e6f..00000000 --- a/RELEASES.md +++ /dev/null @@ -1,40 +0,0 @@ -# Instructions for creating a new release - -Jupyter-Book is [hosted on the pypi repository](https://pypi.org/project/jupyter-book/). -A new release is automatically created via GitHub Actions when a new release is added to the GitHub repository. - -To create a new release of Jupyter Book, follow the [release instructions in the `executablebooks/` meta repository](https://github.com/executablebooks/.github/blob/master/CONTRIBUTING.md#the-process-of-creating-a-release) - -## To create a release - -To create a new release, follow these steps: - -- Ensure that there aren't any extra issues to tackle in - [the milestone for the next release](https://github.com/executablebooks/jupyter-book/milestones?direction=asc&sort=due_date) -- Bump `__init__.py` to the version for the release. Use - [semantic versioning](https://semver.org/) to decide what version to choose. - For example: - - ``` - __version__ = "0.6.1" - ``` -- Create a "release commit": - - ``` - git add jupyter_book - git commit -m "🚀RELEASE: <version-number>" - git push upstream master - ``` -- [Create a new release](https://github.com/executablebooks/jupyter-book/releases/new) on GitHub. - The tag and title should be `v<version-number>`. For example, `v0.6.1`. - - GitHub Actions will automatically deploy this release to PyPI using - [this configuration](https://github.com/executablebooks/jupyter-book/blob/master/.github/workflows/tests.yml#L86). - - Confirm that a new version of the package [is posted to pypi](https://pypi.org/project/jupyter-book/) -- Add a changelog for the latest version by using `github-activity`: - - ``` - github-activity executablebooks/jupyter-book -s <old-version-tag> -u <new-version-tag> - ``` - - Paste the result into the release description on GitHub. -- You're done! 🎉 diff --git a/jupyter_book/__init__.py b/jupyter_book/__init__.py index 671c76b9..0dc82b5a 100644 --- a/jupyter_book/__init__.py +++ b/jupyter_book/__init__.py @@ -5,7 +5,7 @@ from .toc import add_toc_to_sphinx, add_toctree from .directive.toc import TableofContents, SwapTableOfContents -__version__ = "0.8.3" +__version__ = "0.9.0" def add_static_files(app, config): -- GitLab