Skip to content
Snippets Groups Projects
Unverified Commit 7c3835b1 authored by mmcky's avatar mmcky Committed by GitHub
Browse files

:rocket: RELEASE: v0.9.0 (#1129)

* RELEASE: v0.9.0
parent 9794ae55
No related branches found
No related tags found
No related merge requests found
# 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.
......
# 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! 🎉
......@@ -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):
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment