mirror of
https://github.com/sprockets/sprockets.clients.memcached.git
synced 2024-11-25 11:19:53 +00:00
Documentation updates.
This commit is contained in:
Dave Shawley
parent
e5824b43cb
commit
4eada5d6b5
4 changed files with 17 additions and 30 deletions
4
LICENSE
4
LICENSE
|
|
@ -1,4 +1,4 @@
|
|||
Copyright (c) 2014 AWeber Communications
|
||||
Copyright (c) 2014-2018 AWeber Communications
|
||||
All rights reserved.
|
||||
|
||||
Redistribution and use in source and binary forms, with or without modification,
|
||||
|
|
@ -22,4 +22,4 @@ BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|||
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
|
||||
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
|
||||
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
|
||||
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
|
|
|||
14
README.rst
14
README.rst
|
|
@ -2,7 +2,7 @@ sprockets.clients.memcached
|
|||
===========================
|
||||
Memcached client wrapper that is configured via environment variables.
|
||||
|
||||
|Version| |Downloads| |Status| |Coverage| |License|
|
||||
|Version| |Status| |Coverage| |License|
|
||||
|
||||
Installation
|
||||
------------
|
||||
|
|
@ -20,8 +20,7 @@ https://sprocketsclientsmemcached.readthedocs.org
|
|||
|
||||
Requirements
|
||||
------------
|
||||
- `python-memcached <https://pypi.python.org/pypi/python-memcached>`_ (Python 2)
|
||||
- `python3-memcached <https://pypi.python.org/pypi/python3-memcached>`_ (Python 3)
|
||||
- `python-memcached <https://pypi.python.org/pypi/python-memcached>`_
|
||||
|
||||
Example
|
||||
-------
|
||||
|
|
@ -45,7 +44,7 @@ memcached commands:
|
|||
|
||||
Version History
|
||||
---------------
|
||||
Available at https://sprocketsclientsmemcached.readthedocs.org/en/latest/history.html
|
||||
Available at https://sprocketsclientsmemcached.readthedocs.io/en/latest/history.html
|
||||
|
||||
.. |Version| image:: https://badge.fury.io/py/sprockets.clients.memcached.svg?
|
||||
:target: http://badge.fury.io/py/sprockets.clients.memcached
|
||||
|
|
@ -56,8 +55,5 @@ Available at https://sprocketsclientsmemcached.readthedocs.org/en/latest/history
|
|||
.. |Coverage| image:: https://img.shields.io/coveralls/sprockets/sprockets.clients.memcached.svg?
|
||||
:target: https://coveralls.io/r/sprockets/sprockets.clients.memcached
|
||||
|
||||
.. |Downloads| image:: https://pypip.in/d/sprockets.clients.memcached/badge.svg?
|
||||
:target: https://pypi.python.org/pypi/sprockets.clients.memcached
|
||||
|
||||
.. |License| image:: https://pypip.in/license/sprockets.clients.memcached/badge.svg?
|
||||
:target: https://sprocketsclientsmemcached.readthedocs.org
|
||||
.. |License| image:: https://img.shields.io/github/license/sprockets/sprockets.clients.memcached.svg
|
||||
:target: https://sprocketsclientsmemcached.readthedocs.io
|
||||
|
|
|
|||
14
docs/conf.py
14
docs/conf.py
|
|
@ -1,8 +1,6 @@
|
|||
#!/usr/bin/env python
|
||||
import sphinx_rtd_theme
|
||||
|
||||
from sprockets.clients.memcached import version_info, __version__
|
||||
|
||||
needs_sphinx = '1.0'
|
||||
extensions = [
|
||||
'sphinx.ext.autodoc',
|
||||
|
|
@ -14,15 +12,11 @@ templates_path = []
|
|||
source_suffix = '.rst'
|
||||
master_doc = 'index'
|
||||
project = 'sprockets.clients.memcached'
|
||||
copyright = '2014, AWeber Communications'
|
||||
version = '.'.join(__version__.split('.')[0:1])
|
||||
release = __version__
|
||||
if len(version_info) > 3:
|
||||
release += '-{0}'.format(str(v) for v in version_info[3:])
|
||||
copyright = '2014-2018, AWeber Communications'
|
||||
version = '1.0.1'
|
||||
release = '1.0'
|
||||
exclude_patterns = []
|
||||
pygments_style = 'sphinx'
|
||||
html_theme = 'sphinx_rtd_theme'
|
||||
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
|
||||
intersphinx_mapping = {
|
||||
'python': ('https://docs.python.org/2/', None)
|
||||
}
|
||||
intersphinx_mapping = {'python': ('https://docs.python.org/2/', None)}
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@ sprockets.clients.memcached
|
|||
===========================
|
||||
Memcached client wrapper that is configured via environment variables
|
||||
|
||||
|Version| |Downloads| |Status| |Coverage| |License|
|
||||
|Version| |Status| |Coverage| |License|
|
||||
|
||||
Installation
|
||||
------------
|
||||
|
|
@ -12,12 +12,11 @@ and can be installed via ``pip`` or ``easy_install``:
|
|||
|
||||
.. code:: bash
|
||||
|
||||
pip install sprockets.clients.memcached
|
||||
pip install sprockets.clients.memcached
|
||||
|
||||
Requirements
|
||||
------------
|
||||
- `python-memcached <https://pypi.python.org/pypi/python-memcached>`_ (Python 2)
|
||||
- `python3-memcached <https://pypi.python.org/pypi/python3-memcached>`_ (Python 3)
|
||||
- `python-memcached <https://pypi.python.org/pypi/python-memcached>`_
|
||||
|
||||
API Documentation
|
||||
-----------------
|
||||
|
|
@ -26,6 +25,7 @@ API Documentation
|
|||
|
||||
api
|
||||
examples
|
||||
history
|
||||
|
||||
Version History
|
||||
---------------
|
||||
|
|
@ -59,8 +59,5 @@ Indices and tables
|
|||
.. |Coverage| image:: https://img.shields.io/coveralls/sprockets/sprockets.clients.memcached.svg?
|
||||
:target: https://coveralls.io/r/sprockets/sprockets.clients.memcached
|
||||
|
||||
.. |Downloads| image:: https://pypip.in/d/sprockets.clients.memcached/badge.svg?
|
||||
:target: https://pypi.python.org/pypi/sprockets.clients.memcached
|
||||
|
||||
.. |License| image:: https://pypip.in/license/sprockets.clients.memcached/badge.svg?
|
||||
:target: https://sprocketsclientsmemcached.readthedocs.org
|
||||
.. |License| image:: https://img.shields.io/github/license/sprockets/sprockets.clients.memcached.svg
|
||||
:target: https://sprocketsclientsmemcached.readthedocs.io
|
||||
|
|
|
|||
Loading…
Reference in a new issue