Merge pull request #745 from glotzerlab/release/v2.5.1

Release/v2.5.1

.pre-commit-config.yaml

@@ -13,13 +13,13 @@ repos:
       - id: debug-statements
       - id: requirements-txt-fixer
   - repo: https://github.com/asottile/pyupgrade
-    rev: 'v2.10.0'
+    rev: 'v2.11.0'
     hooks:
       - id: pyupgrade
         args:
           - --py36-plus
   - repo: https://github.com/pycqa/isort
-    rev: '5.7.0'
+    rev: '5.8.0'
     hooks:
       - id: isort
   - repo: https://github.com/psf/black

ChangeLog.md

@@ -4,6 +4,11 @@ The format is based on
 and this project adheres to
 [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## v2.5.1 - 2021-04-06
+
+### Fixed
+* Documentation on ReadTheDocs builds and renders.
+
 ## v2.5.0 - 2021-03-16
 
 ### Changed

contributors.txt

@@ -1,8 +1,8 @@
   2066	Vyas Ramasubramani <[email protected]>
-  1862	Bradley Dice <[email protected]>
+  1889	Bradley Dice <[email protected]>
   1030	Eric Harper <[email protected]>
    456	Jin Soo Ihm <[email protected]>
-   281	Joshua A. Anderson <[email protected]>
+   288	Joshua A. Anderson <[email protected]>
    240	Matthew Spellings <[email protected]>
    159	Kelly Wang <[email protected]>
    110	Erin Teich <[email protected]>
@@ -11,10 +11,10 @@
     43	Brandon Butler <[email protected]>
     41	Yezhi Jin <[email protected]>
     40	Antonio Osorio <[email protected]>
+    39	dependabot <dependabot[bot]@users.noreply.github.com>
     35	Michael Stryk <[email protected]>
-    35	dependabot <dependabot[bot]@users.noreply.github.com>
     31	Richmond Newman <[email protected]>
-    30	Tommy Waltmann <[email protected]>
+    31	Tommy Waltmann <[email protected]>
     25	Carl Simon Adorf <[email protected]>
     22	Jens Glaser <[email protected]>
     14	Tim Moore <[email protected]>

doc/source/conf.py

@@ -70,8 +70,8 @@
 # built documents.
 #
 # version and release are set the same for this package.
-version = "2.5.0"
-release = "2.5.0"
+version = "2.5.1"
+release = "2.5.1"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

doc/source/reference/development/releases.rst

@@ -73,11 +73,13 @@ Contributors
 
     git shortlog -sne > contributors.txt
 
+- Check the ``git diff`` for that file. If any contributors are listed twice, update the ``.mailmap`` file so that all contributors are recognized under a canonical name and email. Then re-run the previous command.
+
 Bump version
 ------------
 
 - Commit previous changes before running ``bumpversion``.
-- Use the `bumpversion package <https://pypi.org/project/bumpversion/>`_ to increase the version number and automatically generate a git tag:
+- Use the `bumpversion package <https://pypi.org/project/bumpversion/>`_ to increase the version number:
 
 .. code-block:: bash
 
@@ -97,10 +99,12 @@ Bump version
   Pushing the release branch will cause CircleCI to create a release for TestPyPI automatically (see automation in ``.circleci/config.yml``).
   Make sure this succeeds -- it takes a while to run.
   Review the `TestPyPI builds <https://test.pypi.org/project/freud-analysis/>`__ to ensure the README looks correct.
-  Then push the tag:
+
+- Create and push a tag for the release.
 
 .. code-block:: bash
 
+    git tag -a vX.Y.Z
     git push --tags
 
 Automatic Builds

freud/__init__.py

@@ -23,7 +23,7 @@
 # automatic selection runs, the user cannot change it.
 set_num_threads(0)
 
-__version__ = "2.5.0"
+__version__ = "2.5.1"
 
 __all__ = [
     "__version__",

setup.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 2.5.0
+current_version = 2.5.1
 commit = True
 tag = True
 message = Bump up to version {new_version}.

setup.py

@@ -6,7 +6,7 @@
 
 from skbuild import setup as skbuild_setup
 
-version = "2.5.0"
+version = "2.5.1"
 
 # Read README for PyPI, fallback to short description if it fails.
 description = "Powerful, efficient trajectory analysis in scientific Python."