Skip to content

Commit

Permalink
Internal release documentation revised.
Browse files Browse the repository at this point in the history
This commit revises internally release documentation (i.e., the
`doc/RELEASE.rst` file) to reference our new Hatch + `pyproject.toml`
build toolchain. Welcome to the ultimate "Nuthin' to See Here, Folks"
commit. You have officially seen it all. (*Take all my alimony, antimony!*)
  • Loading branch information
leycec committed Jun 6, 2024
1 parent 60196b3 commit cd6725e
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 6 deletions.
12 changes: 7 additions & 5 deletions doc/RELEASE.rst
Original file line number Diff line number Diff line change
Expand Up @@ -65,21 +65,21 @@ Beartype is releasable to all supported platforms as follows:
PyPI-hosted page <PyPI beartype_>`__ for this project and verify by
cursory inspection that this project's description is rendered as HTML.

#. (\ *Optional*\ ) **Install** wheel_, a third-party pure-Python package
#. (\ *Optional*\ ) **Install** Hatch_, a third-party pure-Python package
permitting this release to be packaged into a cross-platform pre-compiled
binary distribution supported by both PyPI_ and ``pip``. This optional
dependency augments setuptools with the ``bdist_wheel`` subcommand invoked
below when locally testing the generation of binary wheels.
dependency installs the ``hatch`` command invoked below when locally testing
the generation of source tarballs and/or binary wheels.

.. code-block:: shell-session
$ sudo pip3 install wheel
$ sudo pip3 install hatch
#. (\ *Optional*\ ) **Test packaging both a source tarball and binary wheel.**

.. code-block:: shell-session
$ python3 setup.py sdist bdist_wheel
$ hatch build -t sdist -t wheel
#. (\ *Optional*\ ) **List the contents of this source tarball,** where
``${version}`` is the purely numeric version of this release (e.g.,
Expand Down Expand Up @@ -577,6 +577,8 @@ When in doubt, bump only the minor version and reset only the patch version.
https://github.com/betsee/betse
.. _BETSEE:
https://github.com/betsee/betsee
.. _Hatch:
https://hatch.pypa.io

.. # ------------------( LINKS ~ py : pypi )------------------
.. _Test PyPI:
Expand Down
6 changes: 5 additions & 1 deletion doc/src/pep.rst
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,10 @@ you into stunned disbelief that somebody typed all this. [#rsi]_
+------------------------+-----------------------------------------------------------+--------------------------+---------------------------+
| | :pep:`484 <484>` | **0.2.0**\ \ *current* | *none* |
+------------------------+-----------------------------------------------------------+--------------------------+---------------------------+
| | :pep:`517 <517>` || **0.19.0**\ \ *current* |
+------------------------+-----------------------------------------------------------+--------------------------+---------------------------+
| | :pep:`518 <518>` || **0.19.0**\ \ *current* |
+------------------------+-----------------------------------------------------------+--------------------------+---------------------------+
| | :pep:`526 <526>` || **0.15.0**\ \ *current* |
+------------------------+-----------------------------------------------------------+--------------------------+---------------------------+
| | :pep:`544 <544>` || **0.4.0**\ \ *current* |
Expand Down Expand Up @@ -90,7 +94,7 @@ you into stunned disbelief that somebody typed all this. [#rsi]_
+------------------------+-----------------------------------------------------------+--------------------------+---------------------------+
| | :pep:`613 <613>` | *none* | **0.18.0**\ \ *current* |
+------------------------+-----------------------------------------------------------+--------------------------+---------------------------+
| | :pep:`621 <621>` || **0.15.0**\ \ *current* |
| | :pep:`621 <621>` || **0.19.0**\ \ *current* |
+------------------------+-----------------------------------------------------------+--------------------------+---------------------------+
| | :pep:`646 <646>` | *none* | *none* |
+------------------------+-----------------------------------------------------------+--------------------------+---------------------------+
Expand Down

0 comments on commit cd6725e

Please sign in to comment.