Merge pull request #346 from BCG-Gamma/dev/2.1rc0

BUILD: release pytools 2.1rc0

.gitignore

@@ -232,7 +232,7 @@ acs-*.bib
 # endnotes
 *.ent
 
-# fixme
+# fixme_
 *.lox
 
 # feynmf/feynmp
@@ -286,7 +286,7 @@ acs-*.bib
 
 # knitr
 *-concordance.tex
-# TODO Comment the next line if you want to keep your tikz graphics files
+# Comment the next line if you want to keep your tikz graphics files
 *.tikz
 *-tikzDictionary
 
@@ -358,7 +358,7 @@ pythontex-files-*/
 # todonotes
 *.tdo
 
-# easy-todo
+# easy-todo_
 *.lod
 
 # xmpincl

README.rst

@@ -1,4 +1,4 @@
-.. image:: sphinx/source/_static/gamma_pytools_logo.png
+.. image:: sphinx/source/_images/gamma_pytools_logo.png
 
 |
 
@@ -110,7 +110,7 @@ or have a look at
 .. |azure_build| image:: https://dev.azure.com/gamma-facet/facet/_apis/build/status/BCG-Gamma.pytools?branchName=develop
    :target: https://dev.azure.com/gamma-facet/facet/_build?definitionId=9&_a=summary
 
-.. |azure_code_cov| image:: https://img.shields.io/azure-devops/coverage/gamma-facet/facet/9/2.0.x
+.. |azure_code_cov| image:: https://img.shields.io/azure-devops/coverage/gamma-facet/facet/9/2.1.x
    :target: https://dev.azure.com/gamma-facet/facet/_build?definitionId=9&_a=summary
 
 .. |python_versions| image:: https://img.shields.io/badge/python-3.7|3.8|3.9-blue.svg

RELEASE_NOTES.rst

@@ -2,17 +2,38 @@ Release Notes
 =============
 
 .. |mypy| replace:: :external+mypy:doc:`mypy <index>`
+.. |nbsp| unicode:: 0xA0
+   :trim:
+
+*pytools* 2.1
+-------------
+
+2.1.0
+~~~~~
+
+- API: new decorator :obj:`.fitted_only` to mark methods that may only be
+  called after their associated object has been fitted using :meth:`.FittableMixin.fit`.
+- API: remove method ``ensure_fitted`` from :class:`.FittableMixin`, which is no longer
+  needed due to the new decorator :obj:`.fitted_only`.
+- API: new Sphinx callback :class:`.TrackCurrentClass` to keep track of the current
+  class being processed by *autodoc*.
+- API: new Sphinx callback :class:`.RenamePrivateArguments` to rename private
+  “positional-only” arguments in a function's signature (with two leading underscores)
+  back to their original names in the source code, so that *autodoc* can pick them up
+  correctly.
+
 
 *pytools* 2.0
 -------------
 
-*pytools* 2 features enhanced visualisations together with additional API improvements,
+*pytools* 2.0 features enhanced visualisations together with additional API improvements,
 and is now subject to static type checking with |mypy|.
 
 2.0.4
 ~~~~~
 
-- FIX: make :meth:`.MatplotStyle.get_renderer()` compatible with :mod:`matplotlib` 3.6
+- FIX: make :meth:`.MatplotStyle.get_renderer()` compatible with
+  :mod:`matplotlib` |nbsp| 3.6
 
 
 2.0.3
@@ -21,7 +42,7 @@ and is now subject to static type checking with |mypy|.
 - REFACTOR: rename arg of :meth:`.FittableMixin.fit` to ``__x``, so that |mypy|
   recognizes it as a positional-only argument, and that subclasses can change its
   name without breaking the API
-- FIX: make :class:`.ResolveTypeVariables` compatible with Python 3.9
+- FIX: make :class:`.ResolveTypeVariables` compatible with Python |nbsp| 3.9
 - FIX: recognise private (positional-only) arguments in :class:`.DocValidator`
 - DOC: show original names of private (positional-only) arguments in Sphinx
   documentation, not their substituted private names generated by Python
@@ -43,7 +64,7 @@ and is now subject to static type checking with |mypy|.
 - FIX: in class :class:`.AllTracker`, do not attempt to update forward references in
   imported objects
 - BUILD: update build scripts to support the stricter dependency resolver introduced by
-  *pip 20.3*, and to fix a compatibility issue with recent updates to nbsphinx
+  *pip* |nbsp| 20.3, and to fix a compatibility issue with recent updates to nbsphinx
 - BUILD: enable local sphinx builds in other FACET packages
 - DOC: simplify how the docs build manages existing documentation of previous versions
   in the Azure pipeline and the associated commands in `make.py`:
@@ -156,7 +177,7 @@ Additions and enhancements to dendrogram and matrix visualizations.
     to matrix objects
   - API: new attribute :attr:`.MatrixMatplotStyle.nan_substitute` specifies the value to
     look up in the colormap to determine the color of undefined matrix cells
-  - VIZ: :class:`.MatrixMatplotStyle` enforces a 1:1 aspect ratio for the row and
+  - VIZ: :class:`.MatrixMatplotStyle` enforces a 1:1 |nbsp| aspect ratio for the row and
     column axes, so that equal row and column widths represent equal weights
 
 - API: new public method :meth:`.Drawer.get_style_kwargs`, replacing the previously
@@ -176,40 +197,40 @@ Additions and enhancements to dendrogram and matrix visualizations.
 1.2.5
 ~~~~~
 
-This is a maintenance release to catch up with *pytools* 1.1.10.
+This is a maintenance release to catch up with *pytools* |nbsp| 1.1.10.
 
 
 1.2.4
 ~~~~~
 
-This is a maintenance release to catch up with *pytools* 1.1.8.
+This is a maintenance release to catch up with *pytools* |nbsp| 1.1.8.
 
 
 1.2.3
 ~~~~~
 
 This release enhances support for generating Sphinx documentation, and catches up with
-*pytools* 1.1.7.
+*pytools* |nbsp| 1.1.7.
 
 - API: add sphinx processor :class:`.ResolveGenericClassParameters`
   to substitute generic type parameters introduced by base classes or via the
   ``self`` and ``cls`` special method arguments
 - API: add sphinx processor :class:`.AutodocProcessBases` to handle
-  `autodoc-process-bases` events (introduced in Sphinx 4.1)
+  `autodoc-process-bases` events (introduced in Sphinx |nbsp| 4.1)
 - API: function :func:`.validate_type` now accepts multiple alternative types to
   validate values against, in line with how :func:`isinstance` tests for multiple types
 
 
 1.2.2
 ~~~~~
 
-This is a maintenance release to catch up with *pytools* 1.1.5.
+This is a maintenance release to catch up with *pytools* |nbsp| 1.1.5.
 
 
 1.2.1
 ~~~~~
 
-This is a maintenance release to catch up with *pytools* 1.1.4.
+This is a maintenance release to catch up with *pytools* |nbsp| 1.1.4.
 
 
 1.2.0
@@ -247,7 +268,7 @@ This is a bugfix release to restore the GitHub release process.
 
 - BUILD: the ``make_base.py`` build script no longer imports the actual module to obtain
   the current package version, similarly as introduced for ``make.py`` in
-  *pytools* 1.1.7
+  *pytools* |nbsp| 1.1.7
 
 
 1.1.7
@@ -281,7 +302,7 @@ This is a bugfix release to restore the GitHub release process.
 1.1.4
 ~~~~~
 
-- BUILD: add support for :mod:`joblib` 1.0.*
+- BUILD: add support for :mod:`joblib` |nbsp| 1.0.*
 
 
 1.1.3
@@ -296,7 +317,8 @@ This is a bugfix release to restore the GitHub release process.
 1.1.2
 ~~~~~
 
-- Catch up with fixes and pipeline updates introduced by *pytools* 1.0.3 and 1.0.4
+- Catch up with fixes and pipeline updates introduced by *pytools* |nbsp| 1.0.3 and
+  |nbsp| 1.0.4
 - API: support inheriting class docstrings from superclasses using the
   :func:`.inheritdoc` decorator
 - API: new :func:`.subsdoc` decorator to replace text in docstrings
@@ -328,13 +350,13 @@ This is a bugfix release to restore the GitHub release process.
 1.0.6
 ~~~~~
 
-- FIX: back-port 1.1 bugfix for :meth:`.Expression.eq_`
+- FIX: back-port *pytools* |nbsp| 1.1 bugfix for :meth:`.Expression.eq_`
 
 
 1.0.5
 ~~~~~
 
-- FIX: back-port 1.1 bugfix for building multi-version documentation
+- FIX: back-port *pytools* |nbsp| 1.1 bugfix for building multi-version documentation
 
 
 1.0.4
@@ -352,8 +374,8 @@ minor fixes.
 - BUILD: add the ``bcg_gamma`` conda channel when building
 - BUILD: Enforce pre-release for minor and major releases
 - DOC: add pre-commit hook instructions to contribution guide
-- BUILD: update *flake8* to 3.9.0
-- BUILD: apply make_base.py changes from 1.1.x also on develop (adds more robust parsing
+- BUILD: update *flake8* to |nbsp| 3.9.0
+- BUILD: apply make_base.py changes from |nbsp| 1.1.x also on develop (adds more robust parsing
   of package versions)
 - FIX: version syntax adaptation with mixed ``=`` and ``>=``
 
@@ -369,7 +391,7 @@ minor fixes.
   :class:`~matplotlib.axes.Axes` object
 - FIX: preserve correct instance for subclasses of singleton classes
 - FIX: add a few missing type hints
-- BUILD: add support for :mod:`numpy` 1.20
+- BUILD: add support for :mod:`numpy` |nbsp| 1.20
 - BUILD: updates and changes to the CI/CD pipeline