summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorThomas Achtemichuk <tom@tomchuk.com>2018-03-19 13:28:43 -0400
committerOmer Katz <omer.drow@gmail.com>2018-03-19 19:28:43 +0200
commit75695205f6e7af8e7e9178e010debc3871b19106 (patch)
treea45acc3ae34c048d756ea42587b6a0c42d0bd5dc /docs
parentdba85e2d9515b9ce202bd30e8690131aa055e6bf (diff)
downloadkombu-75695205f6e7af8e7e9178e010debc3871b19106.tar.gz
Rename `async` keyword to `asynchronous` (#839)
* Rename `async` keyword to `asynchronous` * Fixes #742 * Resolves "DeprecationWarning: 'async' and 'await' will become reserved keywords in Python 3.7" * Address PR feedback * Update appveyor config * Rename docs and tests
Diffstat (limited to 'docs')
-rw-r--r--docs/conf.py4
-rw-r--r--docs/reference/index.rst28
-rw-r--r--docs/reference/kombu.async.debug.rst11
-rw-r--r--docs/reference/kombu.async.http.base.rst11
-rw-r--r--docs/reference/kombu.async.http.curl.rst11
-rw-r--r--docs/reference/kombu.async.http.rst11
-rw-r--r--docs/reference/kombu.async.rst11
-rw-r--r--docs/reference/kombu.async.semaphore.rst11
-rw-r--r--docs/reference/kombu.asynchronous.aws.connection.rst11
-rw-r--r--docs/reference/kombu.asynchronous.aws.rst (renamed from docs/reference/kombu.async.aws.rst)6
-rw-r--r--docs/reference/kombu.asynchronous.aws.sqs.connection.rst11
-rw-r--r--docs/reference/kombu.asynchronous.aws.sqs.message.rst11
-rw-r--r--docs/reference/kombu.asynchronous.aws.sqs.queue.rst (renamed from docs/reference/kombu.async.aws.sqs.connection.rst)6
-rw-r--r--docs/reference/kombu.asynchronous.aws.sqs.rst (renamed from docs/reference/kombu.async.aws.connection.rst)6
-rw-r--r--docs/reference/kombu.asynchronous.debug.rst11
-rw-r--r--docs/reference/kombu.asynchronous.http.base.rst11
-rw-r--r--docs/reference/kombu.asynchronous.http.curl.rst11
-rw-r--r--docs/reference/kombu.asynchronous.http.rst (renamed from docs/reference/kombu.async.aws.sqs.rst)6
-rw-r--r--docs/reference/kombu.asynchronous.hub.rst (renamed from docs/reference/kombu.async.aws.sqs.queue.rst)6
-rw-r--r--docs/reference/kombu.asynchronous.rst (renamed from docs/reference/kombu.async.timer.rst)6
-rw-r--r--docs/reference/kombu.asynchronous.semaphore.rst (renamed from docs/reference/kombu.async.aws.sqs.message.rst)6
-rw-r--r--docs/reference/kombu.asynchronous.timer.rst (renamed from docs/reference/kombu.async.hub.rst)6
22 files changed, 106 insertions, 106 deletions
diff --git a/docs/conf.py b/docs/conf.py
index 6fa69170..3c6844f7 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -22,8 +22,8 @@ globals().update(conf.build_config(
apicheck_ignore_modules=[
'kombu.entity',
'kombu.messaging',
- 'kombu.async.aws.ext',
- 'kombu.async.aws.sqs.ext',
+ 'kombu.asynchronous.aws.ext',
+ 'kombu.asynchronous.aws.sqs.ext',
'kombu.transport.qpid_patches',
'kombu.utils',
'kombu.transport.virtual.base',
diff --git a/docs/reference/index.rst b/docs/reference/index.rst
index 550b9d7a..092429bc 100644
--- a/docs/reference/index.rst
+++ b/docs/reference/index.rst
@@ -23,20 +23,20 @@
kombu.pools
kombu.abstract
kombu.resource
- kombu.async
- kombu.async.hub
- kombu.async.semaphore
- kombu.async.timer
- kombu.async.debug
- kombu.async.http
- kombu.async.http.base
- kombu.async.http.curl
- kombu.async.aws
- kombu.async.aws.connection
- kombu.async.aws.sqs
- kombu.async.aws.sqs.connection
- kombu.async.aws.sqs.message
- kombu.async.aws.sqs.queue
+ kombu.asynchronous
+ kombu.asynchronous.hub
+ kombu.asynchronous.semaphore
+ kombu.asynchronous.timer
+ kombu.asynchronous.debug
+ kombu.asynchronous.http
+ kombu.asynchronous.http.base
+ kombu.asynchronous.http.curl
+ kombu.asynchronous.aws
+ kombu.asynchronous.aws.connection
+ kombu.asynchronous.aws.sqs
+ kombu.asynchronous.aws.sqs.connection
+ kombu.asynchronous.aws.sqs.message
+ kombu.asynchronous.aws.sqs.queue
kombu.transport
kombu.transport.pyamqp
kombu.transport.librabbitmq
diff --git a/docs/reference/kombu.async.debug.rst b/docs/reference/kombu.async.debug.rst
deleted file mode 100644
index ab67c594..00000000
--- a/docs/reference/kombu.async.debug.rst
+++ /dev/null
@@ -1,11 +0,0 @@
-==========================================================
- Event Loop Debugging Utils - ``kombu.async.debug``
-==========================================================
-
-.. contents::
- :local:
-.. currentmodule:: kombu.async.debug
-
-.. automodule:: kombu.async.debug
- :members:
- :undoc-members:
diff --git a/docs/reference/kombu.async.http.base.rst b/docs/reference/kombu.async.http.base.rst
deleted file mode 100644
index 37dddb0d..00000000
--- a/docs/reference/kombu.async.http.base.rst
+++ /dev/null
@@ -1,11 +0,0 @@
-==========================================================
- Async HTTP Client Interface - ``kombu.async.http.base``
-==========================================================
-
-.. contents::
- :local:
-.. currentmodule:: kombu.async.http.base
-
-.. automodule:: kombu.async.http.base
- :members:
- :undoc-members:
diff --git a/docs/reference/kombu.async.http.curl.rst b/docs/reference/kombu.async.http.curl.rst
deleted file mode 100644
index dc4ebec2..00000000
--- a/docs/reference/kombu.async.http.curl.rst
+++ /dev/null
@@ -1,11 +0,0 @@
-==========================================================
- Async pyCurl HTTP Client - ``kombu.async.http.curl``
-==========================================================
-
-.. contents::
- :local:
-.. currentmodule:: kombu.async.http.curl
-
-.. automodule:: kombu.async.http.curl
- :members:
- :undoc-members:
diff --git a/docs/reference/kombu.async.http.rst b/docs/reference/kombu.async.http.rst
deleted file mode 100644
index 40235631..00000000
--- a/docs/reference/kombu.async.http.rst
+++ /dev/null
@@ -1,11 +0,0 @@
-==========================================================
- Async HTTP Client - ``kombu.async.http``
-==========================================================
-
-.. contents::
- :local:
-.. currentmodule:: kombu.async.http
-
-.. automodule:: kombu.async.http
- :members:
- :undoc-members:
diff --git a/docs/reference/kombu.async.rst b/docs/reference/kombu.async.rst
deleted file mode 100644
index 651f67d8..00000000
--- a/docs/reference/kombu.async.rst
+++ /dev/null
@@ -1,11 +0,0 @@
-==========================================================
- Event Loop - ``kombu.async``
-==========================================================
-
-.. contents::
- :local:
-.. currentmodule:: kombu.async
-
-.. automodule:: kombu.async
- :members:
- :undoc-members:
diff --git a/docs/reference/kombu.async.semaphore.rst b/docs/reference/kombu.async.semaphore.rst
deleted file mode 100644
index b3ac5e0d..00000000
--- a/docs/reference/kombu.async.semaphore.rst
+++ /dev/null
@@ -1,11 +0,0 @@
-==========================================================
- Semaphores - ``kombu.async.semaphore``
-==========================================================
-
-.. contents::
- :local:
-.. currentmodule:: kombu.async.semaphore
-
-.. automodule:: kombu.async.semaphore
- :members:
- :undoc-members:
diff --git a/docs/reference/kombu.asynchronous.aws.connection.rst b/docs/reference/kombu.asynchronous.aws.connection.rst
new file mode 100644
index 00000000..2e5eceb9
--- /dev/null
+++ b/docs/reference/kombu.asynchronous.aws.connection.rst
@@ -0,0 +1,11 @@
+==========================================================
+ Amazon AWS Connection - ``kombu.asynchronous.aws.connection``
+==========================================================
+
+.. contents::
+ :local:
+.. currentmodule:: kombu.asynchronous.aws.connection
+
+.. automodule:: kombu.asynchronous.aws.connection
+ :members:
+ :undoc-members:
diff --git a/docs/reference/kombu.async.aws.rst b/docs/reference/kombu.asynchronous.aws.rst
index 62c7438c..a76b9b5e 100644
--- a/docs/reference/kombu.async.aws.rst
+++ b/docs/reference/kombu.asynchronous.aws.rst
@@ -1,11 +1,11 @@
==========================================================
- Async Amazon AWS Client - ``kombu.async.aws``
+ Async Amazon AWS Client - ``kombu.asynchronous.aws``
==========================================================
.. contents::
:local:
-.. currentmodule:: kombu.async.aws
+.. currentmodule:: kombu.asynchronous.aws
-.. automodule:: kombu.async.aws
+.. automodule:: kombu.asynchronous.aws
:members:
:undoc-members:
diff --git a/docs/reference/kombu.asynchronous.aws.sqs.connection.rst b/docs/reference/kombu.asynchronous.aws.sqs.connection.rst
new file mode 100644
index 00000000..165d9d62
--- /dev/null
+++ b/docs/reference/kombu.asynchronous.aws.sqs.connection.rst
@@ -0,0 +1,11 @@
+==========================================================
+ SQS Connection - ``kombu.asynchronous.aws.sqs.connection``
+==========================================================
+
+.. contents::
+ :local:
+.. currentmodule:: kombu.asynchronous.aws.sqs.connection
+
+.. automodule:: kombu.asynchronous.aws.sqs.connection
+ :members:
+ :undoc-members:
diff --git a/docs/reference/kombu.asynchronous.aws.sqs.message.rst b/docs/reference/kombu.asynchronous.aws.sqs.message.rst
new file mode 100644
index 00000000..ae9f15a7
--- /dev/null
+++ b/docs/reference/kombu.asynchronous.aws.sqs.message.rst
@@ -0,0 +1,11 @@
+==========================================================
+ SQS Messages - ``kombu.asynchronous.aws.sqs.message``
+==========================================================
+
+.. contents::
+ :local:
+.. currentmodule:: kombu.asynchronous.aws.sqs.message
+
+.. automodule:: kombu.asynchronous.aws.sqs.message
+ :members:
+ :undoc-members:
diff --git a/docs/reference/kombu.async.aws.sqs.connection.rst b/docs/reference/kombu.asynchronous.aws.sqs.queue.rst
index 90eeae4f..57bbb3d8 100644
--- a/docs/reference/kombu.async.aws.sqs.connection.rst
+++ b/docs/reference/kombu.asynchronous.aws.sqs.queue.rst
@@ -1,11 +1,11 @@
==========================================================
- SQS Connection - ``kombu.async.aws.sqs.connection``
+ SQS Queues - ``kombu.asynchronous.aws.sqs.queue``
==========================================================
.. contents::
:local:
-.. currentmodule:: kombu.async.aws.sqs.connection
+.. currentmodule:: kombu.asynchronous.aws.sqs.queue
-.. automodule:: kombu.async.aws.sqs.connection
+.. automodule:: kombu.asynchronous.aws.sqs.queue
:members:
:undoc-members:
diff --git a/docs/reference/kombu.async.aws.connection.rst b/docs/reference/kombu.asynchronous.aws.sqs.rst
index 70cf588a..f2d91a17 100644
--- a/docs/reference/kombu.async.aws.connection.rst
+++ b/docs/reference/kombu.asynchronous.aws.sqs.rst
@@ -1,11 +1,11 @@
==========================================================
- Amazon AWS Connection - ``kombu.async.aws.connection``
+ Async Amazon SQS Client - ``kombu.asynchronous.aws.sqs``
==========================================================
.. contents::
:local:
-.. currentmodule:: kombu.async.aws.connection
+.. currentmodule:: kombu.asynchronous.aws.sqs
-.. automodule:: kombu.async.aws.connection
+.. automodule:: kombu.asynchronous.aws.sqs
:members:
:undoc-members:
diff --git a/docs/reference/kombu.asynchronous.debug.rst b/docs/reference/kombu.asynchronous.debug.rst
new file mode 100644
index 00000000..5380de17
--- /dev/null
+++ b/docs/reference/kombu.asynchronous.debug.rst
@@ -0,0 +1,11 @@
+==========================================================
+ Event Loop Debugging Utils - ``kombu.asynchronous.debug``
+==========================================================
+
+.. contents::
+ :local:
+.. currentmodule:: kombu.asynchronous.debug
+
+.. automodule:: kombu.asynchronous.debug
+ :members:
+ :undoc-members:
diff --git a/docs/reference/kombu.asynchronous.http.base.rst b/docs/reference/kombu.asynchronous.http.base.rst
new file mode 100644
index 00000000..09694cac
--- /dev/null
+++ b/docs/reference/kombu.asynchronous.http.base.rst
@@ -0,0 +1,11 @@
+==========================================================
+ Async HTTP Client Interface - ``kombu.asynchronous.http.base``
+==========================================================
+
+.. contents::
+ :local:
+.. currentmodule:: kombu.asynchronous.http.base
+
+.. automodule:: kombu.asynchronous.http.base
+ :members:
+ :undoc-members:
diff --git a/docs/reference/kombu.asynchronous.http.curl.rst b/docs/reference/kombu.asynchronous.http.curl.rst
new file mode 100644
index 00000000..13ab052b
--- /dev/null
+++ b/docs/reference/kombu.asynchronous.http.curl.rst
@@ -0,0 +1,11 @@
+==========================================================
+ Async pyCurl HTTP Client - ``kombu.asynchronous.http.curl``
+==========================================================
+
+.. contents::
+ :local:
+.. currentmodule:: kombu.asynchronous.http.curl
+
+.. automodule:: kombu.asynchronous.http.curl
+ :members:
+ :undoc-members:
diff --git a/docs/reference/kombu.async.aws.sqs.rst b/docs/reference/kombu.asynchronous.http.rst
index 1ab25d41..dc48efd9 100644
--- a/docs/reference/kombu.async.aws.sqs.rst
+++ b/docs/reference/kombu.asynchronous.http.rst
@@ -1,11 +1,11 @@
==========================================================
- Async Amazon SQS Client - ``kombu.async.aws.sqs``
+ Async HTTP Client - ``kombu.asynchronous.http``
==========================================================
.. contents::
:local:
-.. currentmodule:: kombu.async.aws.sqs
+.. currentmodule:: kombu.asynchronous.http
-.. automodule:: kombu.async.aws.sqs
+.. automodule:: kombu.asynchronous.http
:members:
:undoc-members:
diff --git a/docs/reference/kombu.async.aws.sqs.queue.rst b/docs/reference/kombu.asynchronous.hub.rst
index bd338c19..67223e41 100644
--- a/docs/reference/kombu.async.aws.sqs.queue.rst
+++ b/docs/reference/kombu.asynchronous.hub.rst
@@ -1,11 +1,11 @@
==========================================================
- SQS Queues - ``kombu.async.aws.sqs.queue``
+ Event Loop Implementation - ``kombu.asynchronous.hub``
==========================================================
.. contents::
:local:
-.. currentmodule:: kombu.async.aws.sqs.queue
+.. currentmodule:: kombu.asynchronous.hub
-.. automodule:: kombu.async.aws.sqs.queue
+.. automodule:: kombu.asynchronous.hub
:members:
:undoc-members:
diff --git a/docs/reference/kombu.async.timer.rst b/docs/reference/kombu.asynchronous.rst
index 3cc47b5d..6639e1a5 100644
--- a/docs/reference/kombu.async.timer.rst
+++ b/docs/reference/kombu.asynchronous.rst
@@ -1,11 +1,11 @@
==========================================================
- Timer - ``kombu.async.timer``
+ Event Loop - ``kombu.asynchronous``
==========================================================
.. contents::
:local:
-.. currentmodule:: kombu.async.timer
+.. currentmodule:: kombu.asynchronous
-.. automodule:: kombu.async.timer
+.. automodule:: kombu.asynchronous
:members:
:undoc-members:
diff --git a/docs/reference/kombu.async.aws.sqs.message.rst b/docs/reference/kombu.asynchronous.semaphore.rst
index 980cecfe..4ba59042 100644
--- a/docs/reference/kombu.async.aws.sqs.message.rst
+++ b/docs/reference/kombu.asynchronous.semaphore.rst
@@ -1,11 +1,11 @@
==========================================================
- SQS Messages - ``kombu.async.aws.sqs.message``
+ Semaphores - ``kombu.asynchronous.semaphore``
==========================================================
.. contents::
:local:
-.. currentmodule:: kombu.async.aws.sqs.message
+.. currentmodule:: kombu.asynchronous.semaphore
-.. automodule:: kombu.async.aws.sqs.message
+.. automodule:: kombu.asynchronous.semaphore
:members:
:undoc-members:
diff --git a/docs/reference/kombu.async.hub.rst b/docs/reference/kombu.asynchronous.timer.rst
index 1007c79a..870a708d 100644
--- a/docs/reference/kombu.async.hub.rst
+++ b/docs/reference/kombu.asynchronous.timer.rst
@@ -1,11 +1,11 @@
==========================================================
- Event Loop Implementation - ``kombu.async.hub``
+ Timer - ``kombu.asynchronous.timer``
==========================================================
.. contents::
:local:
-.. currentmodule:: kombu.async.hub
+.. currentmodule:: kombu.asynchronous.timer
-.. automodule:: kombu.async.hub
+.. automodule:: kombu.asynchronous.timer
:members:
:undoc-members: