From 05149cc25058bbac1190ab96824184f42563ce2a Mon Sep 17 00:00:00 2001 From: Rob Ruana Date: Thu, 23 Jun 2016 13:25:41 -0400 Subject: [PATCH] Updates copyright date, adds UnicodeMixin to the docs, and bumps sphinx version required for docs --- LICENSE | 2 +- docs/source/conf.py | 5 +++-- docs/source/pockets.rst | 5 +++++ pockets/__init__.py | 2 +- pockets/collections.py | 2 +- pockets/inspect.py | 2 +- pockets/iterators.py | 2 +- pockets/string.py | 2 +- requirements_docs.txt | 3 +-- requirements_test.txt | 3 +-- setup.py | 2 +- tests/test_collections.py | 2 +- tests/test_inspect.py | 2 +- tests/test_iterators.py | 2 +- tests/test_string.py | 2 +- 15 files changed, 21 insertions(+), 17 deletions(-) diff --git a/LICENSE b/LICENSE index 7ef30c9..b14740e 100644 --- a/LICENSE +++ b/LICENSE @@ -1,4 +1,4 @@ -Copyright (c) 2015, by the Pockets team, see AUTHORS. +Copyright (c) 2016 the Pockets team, see AUTHORS. All rights reserved. Redistribution and use in source and binary forms, with or without diff --git a/docs/source/conf.py b/docs/source/conf.py index c6f0cd3..5e50da4 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -42,7 +42,8 @@ # ones. extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', - 'sphinxcontrib.napoleon'] + 'sphinx.ext.viewcode', + 'sphinx.ext.napoleon'] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -58,7 +59,7 @@ # General information about the project. project = u'pockets' -copyright = u'2015, Rob Ruana' +copyright = u'2016, Rob Ruana' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the diff --git a/docs/source/pockets.rst b/docs/source/pockets.rst index d0ff1ca..0761980 100644 --- a/docs/source/pockets.rst +++ b/docs/source/pockets.rst @@ -38,3 +38,8 @@ pockets.string module :members: :undoc-members: :show-inheritance: + +.. autoclass:: pockets.string.UnicodeMixin + :members: + :undoc-members: + :show-inheritance: diff --git a/pockets/__init__.py b/pockets/__init__.py index bd79ef5..c517011 100644 --- a/pockets/__init__.py +++ b/pockets/__init__.py @@ -1,5 +1,5 @@ # -*- coding: utf-8 -*- -# Copyright (c) 2015, by the Pockets team, see AUTHORS. +# Copyright (c) 2016 the Pockets team, see AUTHORS. # Licensed under the BSD License, see LICENSE for details. """*Let me check my pockets...* diff --git a/pockets/collections.py b/pockets/collections.py index e025852..144ee82 100644 --- a/pockets/collections.py +++ b/pockets/collections.py @@ -1,5 +1,5 @@ # -*- coding: utf-8 -*- -# Copyright (c) 2015, by the Pockets team, see AUTHORS. +# Copyright (c) 2016 the Pockets team, see AUTHORS. # Licensed under the BSD License, see LICENSE for details. """A pocket full of useful collection functions!""" diff --git a/pockets/inspect.py b/pockets/inspect.py index c01ffa4..709e372 100644 --- a/pockets/inspect.py +++ b/pockets/inspect.py @@ -1,5 +1,5 @@ # -*- coding: utf-8 -*- -# Copyright (c) 2015, by the Pockets team, see AUTHORS. +# Copyright (c) 2016 the Pockets team, see AUTHORS. # Licensed under the BSD License, see LICENSE for details. """A pocket full of useful reflection functions!""" diff --git a/pockets/iterators.py b/pockets/iterators.py index 6264bc8..5be571e 100644 --- a/pockets/iterators.py +++ b/pockets/iterators.py @@ -1,5 +1,5 @@ # -*- coding: utf-8 -*- -# Copyright (c) 2015, by the Pockets team, see AUTHORS. +# Copyright (c) 2016 the Pockets team, see AUTHORS. # Licensed under the BSD License, see LICENSE for details. """A pocket full of useful iterators!""" diff --git a/pockets/string.py b/pockets/string.py index 6af6739..3495493 100644 --- a/pockets/string.py +++ b/pockets/string.py @@ -1,5 +1,5 @@ # -*- coding: utf-8 -*- -# Copyright (c) 2015, by the Pockets team, see AUTHORS. +# Copyright (c) 2016 the Pockets team, see AUTHORS. # Licensed under the BSD License, see LICENSE for details. """A pocket full of useful string manipulation functions!""" diff --git a/requirements_docs.txt b/requirements_docs.txt index 61910c9..b35501a 100644 --- a/requirements_docs.txt +++ b/requirements_docs.txt @@ -1,3 +1,2 @@ six>=1.5.2 -Sphinx==1.2.3 -sphinxcontrib-napoleon>=0.3.1 +Sphinx>=1.4 diff --git a/requirements_test.txt b/requirements_test.txt index 93423d4..0437314 100644 --- a/requirements_test.txt +++ b/requirements_test.txt @@ -1,6 +1,5 @@ six>=1.5.2 -Sphinx==1.2.3 -sphinxcontrib-napoleon>=0.3.1 +Sphinx>=1.4 coverage>=3.7.1 flake8>=2.3.0 pytest>=2.6.4 diff --git a/setup.py b/setup.py index fda15f5..b96325b 100644 --- a/setup.py +++ b/setup.py @@ -1,5 +1,5 @@ # -*- coding: utf-8 -*- -# Copyright (c) 2015, by the Pockets team, see AUTHORS. +# Copyright (c) 2016 the Pockets team, see AUTHORS. # Licensed under the BSD License, see LICENSE for details. """A collection of helpful Python tools!""" diff --git a/tests/test_collections.py b/tests/test_collections.py index 0876cde..e26b891 100644 --- a/tests/test_collections.py +++ b/tests/test_collections.py @@ -1,5 +1,5 @@ # -*- coding: utf-8 -*- -# Copyright (c) 2015, by the Pockets team, see AUTHORS. +# Copyright (c) 2016 the Pockets team, see AUTHORS. # Licensed under the BSD License, see LICENSE for details. """Tests for :mod:`pockets.collections` module.""" diff --git a/tests/test_inspect.py b/tests/test_inspect.py index cb15ced..9b979ef 100644 --- a/tests/test_inspect.py +++ b/tests/test_inspect.py @@ -1,5 +1,5 @@ # -*- coding: utf-8 -*- -# Copyright (c) 2015, by the Pockets team, see AUTHORS. +# Copyright (c) 2016 the Pockets team, see AUTHORS. # Licensed under the BSD License, see LICENSE for details. """Tests for :mod:`pockets.inspect` module.""" diff --git a/tests/test_iterators.py b/tests/test_iterators.py index 3b9756a..66029d1 100644 --- a/tests/test_iterators.py +++ b/tests/test_iterators.py @@ -1,5 +1,5 @@ # -*- coding: utf-8 -*- -# Copyright (c) 2015, by the Pockets team, see AUTHORS. +# Copyright (c) 2016 the Pockets team, see AUTHORS. # Licensed under the BSD License, see LICENSE for details. """Tests for :mod:`pockets.iterators` module.""" diff --git a/tests/test_string.py b/tests/test_string.py index 5a72fad..a90bcfc 100644 --- a/tests/test_string.py +++ b/tests/test_string.py @@ -1,5 +1,5 @@ # -*- coding: utf-8 -*- -# Copyright (c) 2015, by the Pockets team, see AUTHORS. +# Copyright (c) 2016 the Pockets team, see AUTHORS. # Licensed under the BSD License, see LICENSE for details. """Tests for :mod:`pockets.string` module."""