Skip to content

Commit

Permalink
Release 6.1: Add Sphinx :pypi:... role
Browse files Browse the repository at this point in the history
  • Loading branch information
xolox committed Feb 10, 2020
1 parent 68c4f90 commit bec20db
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 8 deletions.
14 changes: 13 additions & 1 deletion CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,18 @@ Changelog`_ . This project adheres to `semantic versioning`_.
.. _Keep a Changelog: http://keepachangelog.com/
.. _semantic versioning: http://semver.org/

`Release 6.1`_ (2020-02-10)
---------------------------

- Added a ``:pypy:`…``` role for easy linking to packages on the Python Package
Index, for details refer to :func:`humanfriendly.sphinx.pypi_role()`.

- Wasted quite a bit of time debugging a MacOS failure on Travis CI caused by a
broken :man:`pip` installation, fixed by using ``get-pip.py`` to bootstrap an
installation that actually works 😉.

.. _Release 6.1: https://github.com/xolox/python-humanfriendly/compare/6.0...6.1

`Release 6.0`_ (2020-02-09)
---------------------------

Expand All @@ -19,7 +31,7 @@ Changelog`_ . This project adheres to `semantic versioning`_.
- Enable :class:`~humanfriendly.testing.MockedProgram` to customize the shell
script code of mocked programs. This was added to make it easy to mock a
program that is expected to generate specific output (I'm planning to use
this in the linux-utils_ test suite).
this in the :pypi:`linux-utils` test suite).

- Defined ``__all__`` for all public modules that previously lacked "export
control" and decided to bump the major version number as a precaution:
Expand Down
4 changes: 2 additions & 2 deletions humanfriendly/__init__.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Human friendly input/output in Python.
#
# Author: Peter Odding <peter@peterodding.com>
# Last Change: February 9, 2020
# Last Change: February 10, 2020
# URL: https://humanfriendly.readthedocs.io

"""The main module of the `humanfriendly` package."""
Expand Down Expand Up @@ -93,7 +93,7 @@
)

# Semi-standard module versioning.
__version__ = '6.0'
__version__ = '6.1'

# Spinners are redrawn at most this many seconds.
minimum_spinner_interval = 0.2
Expand Down
10 changes: 5 additions & 5 deletions humanfriendly/sphinx.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@
"""
Customizations for and integration with the Sphinx_ documentation generator.
The :mod:`humanfriendly.sphinx` module uses the `Sphinx extension API`_ to
customize the process of generating Sphinx based Python documentation. The
most relevant functions to take a look at for users of this module are
:func:`setup()`, :func:`enable_man_role()`, :func:`enable_special_methods()`
and :func:`enable_usage_formatting()`.
The :mod:`humanfriendly.sphinx` module uses the `Sphinx extension API`_
to customize the process of generating Sphinx based Python documentation.
The most relevant functions to take a look at for users of this module are
:func:`setup()`, :func:`enable_man_role()`, :func:`enable_pypi_role()`,
:func:`enable_special_methods()` and :func:`enable_usage_formatting()`.
.. _Sphinx: http://www.sphinx-doc.org/
.. _Sphinx extension API: http://sphinx-doc.org/extdev/appapi.html
Expand Down

0 comments on commit bec20db

Please sign in to comment.