Skip to content

Commit

Permalink
Updating documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
eandersson committed Jul 28, 2016
1 parent 417d15c commit 2f289d7
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 13 deletions.
4 changes: 2 additions & 2 deletions README.rst
Expand Up @@ -9,7 +9,7 @@ Introduction
AMQP-Storm is a library designed to be consistent, stable and thread-safe.

- 100% Unit-test Coverage!
- Supports Python 2.6, 2.7 and Python 3+.
- Supports Python 2.6, 2.7 and Python 3.3+.
- When using a SSL connection, TLSv1 or higher is required.

Documentation
Expand All @@ -31,4 +31,4 @@ Special thanks to gmr (Gavin M. Roy) for creating pamqp, and in addition amqpsto
:target: https://travis-ci.org/eandersson/amqpstorm

.. |Coverage| image:: https://codecov.io/gh/eandersson/amqpstorm/branch/master/graph/badge.svg
:target: https://codecov.io/gh/eandersson/amqpstorm
:target: https://codecov.io/gh/eandersson/amqpstorm
14 changes: 9 additions & 5 deletions docs/index.rst
Expand Up @@ -3,15 +3,20 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
amqpstorm package
AMQPStorm package
=================
Thread-safe Python RabbitMQ Client Library based on pamqp.

Installation
------------
amqpstorm can be installed by running :command:`pip install amqpstorm`
AMQPStorm can be installed by running :command:`pip install amqpstorm`

Contents:
Examples
--------
A wide verity of examples is available on Github at `https://github.com/eandersson/amqpstorm/tree/master/examples <https://github.com/eandersson/amqpstorm/tree/master/examples>`_

API Documentation
-----------------

.. toctree::
:glob:
Expand All @@ -25,12 +30,11 @@ Please report any issues to the Github repo at `https://github.com/eandersson/am

Source
------
amqpstorm source is available on Github at `https://github.com/eandersson/amqp-storm <https://github.com/eandersson/amqp-storm>`_
AMQPStorm source code is available on Github at `https://github.com/eandersson/amqp-storm <https://github.com/eandersson/amqp-storm>`_

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

10 changes: 4 additions & 6 deletions setup.py
@@ -1,13 +1,10 @@
from setuptools import setup

long_description = """
See https://github.com/eandersson/amqpstorm for more information.
"""

setup(name='AMQPStorm',
version='2.0.0a1',
version='2.0.0',
description='Thread-safe Python RabbitMQ Client Library based on pamqp.',
long_description=long_description,
long_description=open('README.rst').read(),
author='Erik Olof Gunnar Andersson',
author_email='me@eandersson.net',
include_package_data=True,
Expand Down Expand Up @@ -37,4 +34,5 @@
'Topic :: Internet',
'Topic :: Software Development :: Libraries',
'Topic :: Software Development :: Libraries :: Python Modules',
'Topic :: System :: Networking'])
'Topic :: System :: Networking'
])

0 comments on commit 2f289d7

Please sign in to comment.