summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJon Parise <jon@pinterest.com>2020-04-28 09:25:35 -0700
committerGitHub <noreply@github.com>2020-04-28 09:25:35 -0700
commit073c4d9ff11c716f9d980ed144cb80380dddb302 (patch)
tree6816ed1a247cf5b32341bfe71f5ac233a6ca99ea
parent465089a816686720aa9934eac964789da82da7a0 (diff)
downloadpymemcache-073c4d9ff11c716f9d980ed144cb80380dddb302.tar.gz
Upgrade to Sphinx 3 for generated documentation (#282)
-rw-r--r--.github/CODEOWNERS2
-rw-r--r--docs-requirements.txt2
-rw-r--r--docs/conf.py8
-rw-r--r--pymemcache/serde.py5
4 files changed, 8 insertions, 9 deletions
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
index e7fd9e5..8405564 100644
--- a/.github/CODEOWNERS
+++ b/.github/CODEOWNERS
@@ -1,2 +1,2 @@
# Global
-* @cgordon @jogo @jparise @nichochar
+* @cgordon @jogo @jparise
diff --git a/docs-requirements.txt b/docs-requirements.txt
index 9263a6b..eeb93f7 100644
--- a/docs-requirements.txt
+++ b/docs-requirements.txt
@@ -1,3 +1,3 @@
-sphinx==1.4.5
+sphinx==3.0.3
sphinx_rtd_theme
sphinxcontrib-napoleon
diff --git a/docs/conf.py b/docs/conf.py
index 58f0875..1f87dc9 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -26,7 +26,7 @@ sys.path.insert(0, os.path.abspath('.'))
# If your documentation needs a minimal Sphinx version, state it here.
#
-needs_sphinx = '1.4.5'
+needs_sphinx = '3.0.0'
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
@@ -56,8 +56,8 @@ master_doc = 'index'
# General information about the project.
project = u'pymemcache'
-copyright = u'Pinterest 2019'
-author = u'Charles Gordon, Nicholas Charriere, Jon Parise, Joe Gordon'
+copyright = u'Pinterest 2020'
+author = u'Charles Gordon, Jon Parise, Joe Gordon'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
@@ -267,7 +267,7 @@ latex_elements = {
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'pymemcache.tex', u'pymemcache Documentation',
- u'Charles Gordon, Nicholas Charriere, Jon Parise, Joe Gordon', 'manual'),
+ u'Charles Gordon, Jon Parise, Joe Gordon', 'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
diff --git a/pymemcache/serde.py b/pymemcache/serde.py
index f2714f3..cad1f99 100644
--- a/pymemcache/serde.py
+++ b/pymemcache/serde.py
@@ -110,7 +110,8 @@ def python_memcache_deserializer(key, value, flags):
class PickleSerde(object):
"""
An object which implements the serialization/deserialization protocol for
- :py:class:`pymemcache.client.base.Client` and its descendants using pickle_.
+ :py:class:`pymemcache.client.base.Client` and its descendants using the
+ :mod:`pickle` module.
Serialization and deserialization are implemented as methods of this class.
To implement a custom serialization/deserialization method for pymemcache,
@@ -122,8 +123,6 @@ class PickleSerde(object):
For more details on the serialization protocol, see the class documentation
for :py:class:`pymemcache.client.base.Client`
-
- .. pickle: https://docs.python.org/3/library/pickle.html
"""
def __init__(self, pickle_version=DEFAULT_PICKLE_VERSION):
self._serialize_func = get_python_memcache_serializer(pickle_version)