Merge pull request #303 from hakonanes/fix-300-minor-branch

Backport #301

RELEASE.rst

@@ -22,8 +22,14 @@ This guide should be updated after every new release!
   release branch: https://readthedocs.org/projects/kikuchipy/.
 
 - On the master branch, increment the version number in `release.py` to the next
-  ``.dev0``.
-
+  `.dev0`.
+- If a release candidate (RC) is to be made, make a PR to the release branch
+  with `-rc.1` added to the version name, like v0.42.0-rc.1, merge the PR after
+  all checks pass, and publish an RC release off of the release branch. See that
+  it is made available via PyPI, download it with the `dev` dependencies, and
+  run the tests to make sure everything is as it should be. Also check that
+  Binder can build the repository successfully by going to the Read the Docs PR
+  check in the RC PR above after the RC release.
 - Create a release draft (tag) via the GitHub repo from the release branch with
   the correct tag version name, e.g. v0.42.x and release title (see previous
   releases). Add the new release notes from the changelog. Publish the release.

doc/changelog.rst

@@ -12,6 +12,18 @@ project adheres to `Semantic Versioning <https://semver.org/spec/v2.0.0.html>`_.
 Contributors to each release are listed in alphabetical order by first name. 
 List entries are sorted in descending chronological order.
 
+0.3.1 (2021-01-22)
+==================
+
+Contributors
+------------
+- Håkon Wiik Ånes
+
+Fixed
+-----
+- Version link Binder uses to make the Jupyter Notebooks run in the browser.
+  (`#301 <https://github.com/pyxem/kikuchipy/pull/301>`_)
+
 0.3.0 (2021-01-22)
 ==================
 

doc/conf.py

@@ -113,7 +113,7 @@
 if "dev" in version:
     release_version = "master"
 else:
-    release_version = version
+    release_version = "v" + version
 # This is processed by Jinja2 and inserted before each notebook
 nbsphinx_prolog = (
     r"""

doc/pattern_matching.ipynb

@@ -69,7 +69,8 @@
     "import kikuchipy as kp\n",
     "\n",
     "\n",
-    "s = kp.data.nickel_ebsd_large()  # Use kp.load(\"data.h5\") to load your own data\n",
+    "# Use kp.load(\"data.h5\") to load your own data\n",
+    "s = kp.data.nickel_ebsd_large(allow_download=True)  # External download\n",
     "s"
    ]
   },

kikuchipy/release.py

@@ -34,4 +34,4 @@
 name = "kikuchipy"
 platforms = ["Linux", "MacOS X", "Windows"]
 status = "Development"
-version = "0.3.0"
+version = "0.3.1"