From 7ff8aa7410c55088a4a882cc63c04bda4119682b Mon Sep 17 00:00:00 2001
From: mmcky <mmcky@users.noreply.github.com>
Date: Fri, 15 Oct 2021 14:38:48 +1100
Subject: [PATCH] =?UTF-8?q?=F0=9F=9A=80=20RELEASE:=20Setup=20and=20Changes?=
=?UTF-8?q?=20for=20v0.12=20(#1494)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
* RELEASE: update to v0.12
* add myst_deprecations notification to CHANGELOG
* update CHANGELOG
* fix myst-nb intersphinx link
* FIX: broken links to myst-nb due to https://github.com/executablebooks/MyST-NB/pull/365
* add thanks to contributors
* update thanks
* Sphinx 4 in github actions
* upgrade win, os x tests to python=3.8; and pypi publish workflow
* update cache key to be more generic
* use a simple test matrix to set python-version
* FIX: add $
Co-authored-by: Chris Holdgraf <choldgraf@gmail.com>
---
.github/workflows/tests.yml | 33 ++++++++++++++++++---------------
CHANGELOG.md | 20 ++++++++++++++++++++
docs/advanced/sphinx.md | 2 +-
docs/content/execute.md | 2 +-
docs/file-types/jupytext.Rmd | 2 +-
jupyter_book/__init__.py | 2 +-
6 files changed, 42 insertions(+), 19 deletions(-)
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
index e26b5e18..94aa55f5 100644
--- a/.github/workflows/tests.yml
+++ b/.github/workflows/tests.yml
@@ -83,11 +83,8 @@ jobs:
runs-on: ubuntu-latest
strategy:
matrix:
- python-version: [3.6, 3.7]
- sphinx: [">=3,<4"]
- include:
- - python-version: 3.8
- sphinx: ">=2,<3"
+ python-version: ["3.6", "3.7", "3.8"]
+ sphinx: [">=3,<4", ">=4,<5"]
steps:
- uses: actions/checkout@v2
@@ -114,19 +111,22 @@ jobs:
name: Tests on Windows
runs-on: windows-latest
+ strategy:
+ matrix:
+ python-version: [3.8]
steps:
- uses: actions/checkout@v2
- - name: Set up Python 3.7
+ - name: Set up Python 3.8
uses: actions/setup-python@v2
with:
- python-version: 3.7
+ python-version: 3.8
- uses: actions/cache@v2
with:
path: ~\AppData\Local\pip\Cache
- key: ${{ runner.os }}-pip-${{ hashFiles('setup.py') }}
+ key: ${{ runner.os }}-${{ matrix.python-version }}-pip-${{ hashFiles('setup.py') }}
restore-keys: |
- ${{ runner.os }}-pip-
+ ${{ runner.os }}-${{ matrix.python-version }}-pip-
- name: Install Python dependencies
run: |
python -m pip install --upgrade pip
@@ -139,19 +139,22 @@ jobs:
build-book-osx:
name: Build docs on OSX
runs-on: macos-latest
+ strategy:
+ matrix:
+ python-version: [3.8]
steps:
- uses: actions/checkout@v2
- - name: Set up Python 3.7
+ - name: Set up Python 3.8
uses: actions/setup-python@v2
with:
- python-version: 3.7
+ python-version: 3.8
- uses: actions/cache@v2
with:
path: ~\AppData\Local\pip\Cache
- key: ${{ runner.os }}-pip-${{ hashFiles('setup.py') }}
+ key: ${{ runner.os }}-${{ matrix.python-version }}-pip-${{ hashFiles('setup.py') }}
restore-keys: |
- ${{ runner.os }}-pip-
+ ${{ runner.os }}-${{ matrix.python-version }}-pip-
- name: Install Python dependencies
run: |
python -m pip install --upgrade pip
@@ -171,10 +174,10 @@ jobs:
steps:
- name: Checkout source
uses: actions/checkout@v2
- - name: Set up Python 3.7
+ - name: Set up Python 3.8
uses: actions/setup-python@v1
with:
- python-version: 3.7
+ python-version: 3.8
- name: Build package
run: |
pip install wheel
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 39ff859e..d66f0f9b 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,5 +1,25 @@
# Change Log
+## v0.12.0
+
+### New
+
+The primary change in this release is to update the requirements of `jupyter-book` from `sphinx>=2,4` to `sphinx>=3,<5` to support `sphinx>=4` via [#1448](https://github.com/executablebooks/jupyter-book/pull/1448).
+
+This includes upgrades to underlying packages:
+
+- `myst-nb` has been upgrade from `myst-nb~=0.12.0` to `myst-nb~=0.13.1`. Some new features were added in `v0.13+` and can
+ be seen in the [myst-nb changelog](https://github.com/executablebooks/MyST-NB/blob/master/CHANGELOG.md#change-log)
+- additional projects such as [jupytext](https://github.com/mwouts/jupytext), [sphinx-external-toc](https://github.com/executablebooks/sphinx-external-toc), [sphinx-jupyterbook-latex](https://github.com/executablebooks/sphinx-jupyterbook-latex), [sphinx-panels](https://github.com/executablebooks/sphinx-panels), and [sphinx-book-theme](https://github.com/executablebooks/sphinx-book-theme) were also upgraded as part of this release.
+
+Documentation has also received updates and fixes.
+
+Thanks to @bryanwweber, @chrisjsewell, @choldgraf, @gabri470, @jmshea, @joelostblom, @mmcky, @patrickmineault, @TomasBeuzen
+
+### Deprecations from upgrade to `myst-parser`
+
+- The [deprecations made to extension configurations and colon fences in `0.13.0`](https://github.com/executablebooks/MyST-Parser/blob/master/CHANGELOG.md#remove-v013-deprecations-%EF%B8%8F) have now been removed
+
## v0.11.3
This release enables the use of the [singlehtml builder](https://www.sphinx-doc.org/en/master/usage/builders/index.html#sphinx.builders.singlehtml.SingleFileHTMLBuilder) and updates [sphinx-thebe](https://github.com/executablebooks/sphinx-thebe) and [sphinx-book-theme](https://github.com/executablebooks/sphinx-book-theme)
diff --git a/docs/advanced/sphinx.md b/docs/advanced/sphinx.md
index d8598522..80d34a10 100644
--- a/docs/advanced/sphinx.md
+++ b/docs/advanced/sphinx.md
@@ -217,7 +217,7 @@ These two extensions are highly customizable *via* Sphinx configuration.
Some of their configuration is already exposed in the `_config.yml`, but you can also directly set configuration, see:
* the [MyST-Parser configuration options](myst-parser:sphinx/config-options)
-* the [MyST-NB configuration options](myst-nb:start/config-options)
+* the [MyST-NB configuration options](myst-nb:config/reference)
(sphinx/tex-macros)=
### Defining TeX macros
diff --git a/docs/content/execute.md b/docs/content/execute.md
index 60398396..93ce899f 100644
--- a/docs/content/execute.md
+++ b/docs/content/execute.md
@@ -291,7 +291,7 @@ These outputs may appear in a mixed order and you may want them to be grouped an
to display the correct `logical` ordering.
This can be achieved using the [nb_merge_streams feature contained in
-`myst_nb`](myst-nb:use/formatting_outputs.html#group-stderr-stdout).
+`myst_nb`](myst-nb:use/format/group-stderr-stdout).
You can enable this in your `_config.yml`:
diff --git a/docs/file-types/jupytext.Rmd b/docs/file-types/jupytext.Rmd
index ff6ef640..8b175d65 100644
--- a/docs/file-types/jupytext.Rmd
+++ b/docs/file-types/jupytext.Rmd
@@ -66,7 +66,7 @@ This key should be a list mapping each cell to the starting line number in the o
}
```
-This mapping allows for "true" error reporting, as described in [](myst-nb:start/error-reporting).
+This mapping allows for "true" error reporting, as described in [](myst-nb:myst/error-reporting).
## Using Jupytext
diff --git a/jupyter_book/__init__.py b/jupyter_book/__init__.py
index eca71ec7..cb59b85c 100644
--- a/jupyter_book/__init__.py
+++ b/jupyter_book/__init__.py
@@ -1,7 +1,7 @@
"""Build a book with Jupyter Notebooks and Sphinx."""
from pathlib import Path
-__version__ = "0.11.3"
+__version__ = "0.12.0"
def add_static_files(app, config):
--
GitLab