Skip to content

Commit

Permalink
Upgrade to Sphinx 3 for generated documentation (#282)
Browse files Browse the repository at this point in the history
  • Loading branch information
jparise authored Apr 28, 2020
1 parent 465089a commit 073c4d9
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 9 deletions.
2 changes: 1 addition & 1 deletion .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
# Global
* @cgordon @jogo @jparise @nichochar
* @cgordon @jogo @jparise
2 changes: 1 addition & 1 deletion docs-requirements.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
sphinx==1.4.5
sphinx==3.0.3
sphinx_rtd_theme
sphinxcontrib-napoleon
8 changes: 4 additions & 4 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@

# 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
Expand Down Expand Up @@ -56,8 +56,8 @@

# 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
Expand Down Expand Up @@ -267,7 +267,7 @@
# 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
Expand Down
5 changes: 2 additions & 3 deletions pymemcache/serde.py
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand All @@ -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)
Expand Down

0 comments on commit 073c4d9

Please sign in to comment.