diff options
author | Seth Morton <seth.m.morton@gmail.com> | 2019-11-13 11:51:06 -0800 |
---|---|---|
committer | Seth Morton <seth.m.morton@gmail.com> | 2019-11-13 11:51:06 -0800 |
commit | 7c9d01545a9cfd9ac3c0485183cb6ed9ec956837 (patch) | |
tree | 17a5055dda6f4ffe8da921f83fc2e59bec2486cc /docs | |
parent | 60b86c3b6ee63112da3cc866982278b08b86a3ee (diff) | |
download | natsort-7c9d01545a9cfd9ac3c0485183cb6ed9ec956837.tar.gz |
Re-remove Python 2.7 support.
Diffstat (limited to 'docs')
-rw-r--r-- | docs/conf.py | 16 | ||||
-rw-r--r-- | docs/examples.rst | 25 |
2 files changed, 8 insertions, 33 deletions
diff --git a/docs/conf.py b/docs/conf.py index 31f1fed..bd6c2e0 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -49,9 +49,9 @@ source_suffix = ['.rst', '.md'] master_doc = 'index' # General information about the project. -project = u'natsort' +project = 'natsort' # noinspection PyShadowingBuiltins -copyright = u'2014, Seth M. Morton' +copyright = '2014, Seth M. Morton' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the @@ -210,8 +210,8 @@ latex_elements = { # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ - ('index', 'natsort.tex', u'natsort Documentation', - u'Seth M. Morton', 'manual'), + ('index', 'natsort.tex', 'natsort Documentation', + 'Seth M. Morton', 'manual'), ] # The name of an image file (relative to this directory) to place at the top of @@ -240,8 +240,8 @@ latex_documents = [ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - ('index', 'natsort', u'natsort Documentation', - [u'Seth M. Morton'], 1) + ('index', 'natsort', 'natsort Documentation', + ['Seth M. Morton'], 1) ] # If true, show URL addresses after external links. @@ -254,8 +254,8 @@ man_pages = [ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - ('index', 'natsort', u'natsort Documentation', - u'Seth M. Morton', 'natsort', 'One line description of project.', + ('index', 'natsort', 'natsort Documentation', + 'Seth M. Morton', 'natsort', 'One line description of project.', 'Miscellaneous'), ] diff --git a/docs/examples.rst b/docs/examples.rst index f09f8e5..2c56a87 100644 --- a/docs/examples.rst +++ b/docs/examples.rst @@ -314,31 +314,6 @@ need to pass a key to the :meth:`list.sort` method. The function :func:`~natsort_keygen` has the same API as :func:`~natsorted` (minus the `reverse` option). -Natural Sorting with ``cmp`` (Python 2 only) --------------------------------------------- - -.. note:: - This is a Python2-only feature! The :func:`natcmp` function is not - exposed on Python3. Because this documentation is built with - Python3, you will not find :func:`natcmp` in the API. - -If you are using a legacy codebase that requires you to use :func:`cmp` instead -of a key-function, you can use :func:`~natcmp`. - -.. code-block:: pycon - - >>> import sys - >>> a = ['2 ft 7 in', '1 ft 5 in', '10 ft 2 in', '2 ft 11 in', '7 ft 6 in'] - >>> if sys.version_info[0] == 2: - ... from natsort import natcmp - ... sorted(a, cmp=natcmp) - ... else: - ... natsorted(a) # so docstrings don't fail - ['1 ft 5 in', '2 ft 7 in', '2 ft 11 in', '7 ft 6 in', '10 ft 2 in'] - -:func:`natcmp` also accepts an ``alg`` argument so you can customize your -sorting experience. - Sorting Multiple Lists According to a Single List ------------------------------------------------- |