Skip to content

Commit 963e08d

Browse files
committed
Fix assorted docs warnings
1 parent fc8aff1 commit 963e08d

5 files changed

Lines changed: 20 additions & 13 deletions

File tree

docs/applications/turn_channels_api.rst

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
Turn Channels API (EXPERIMENTAL: DO NOT USE IN PRODUCTION)
2-
-------------------
2+
----------------------------------------------------------
33

44
This application provides bidirectional messaging over HTTP, intended
55
for integration with `Turn's Channels API <https://whatsapp.turn.io/docs/api/channel_api>`_.
66

77
Currently this only supports text message types. A future iteration will support other types.
88

9+
.. py:currentmodule:: vumi2.applications.turn_channels_api
10+
911
Configuration
1012
^^^^^^^^^^^^^
1113

@@ -143,17 +145,17 @@ Inbound messages that are ``POST``\ed to :py:data:`turn_api_url`/messages have t
143145
.. http:post:: /<turn_api_url>/messages
144146
145147
:<json dict contact: Information about the contact who sent the message.
146-
:<json str contact.id: The Turn contact ID, which is an MSISDN.
147-
:<json dict contact.profile: The contact's profile information.
148-
:<json str contact.profile.name: The contact's name.
148+
:<json str contact.id: The Turn contact ID, which is an MSISDN.
149+
:<json dict contact.profile: The contact's profile information.
150+
:<json str contact.profile.name: The contact's name.
149151

150152
:<json dict message: The message received from the user.
151-
:<json str message.type: The type of message. Currently only ``text`` is supported.
152-
:<json dict message.text: Required when message type is ``text``.
153-
:<json str message.text.body: The text content of the message.
154-
:<json str message.from: The user ID as an MSISDN. A Channel can respond to a user using this ID.
155-
:<json str message.id: The ID for the message that was received by the Channel.
156-
:<json int message.timestamp: Unix timestamp indicating when the message was received from the user.
153+
:<json str message.type: The type of message. Currently only ``text`` is supported.
154+
:<json dict message.text: Required when message type is ``text``.
155+
:<json str message.text.body: The text content of the message.
156+
:<json str message.from: The user ID as an MSISDN. A Channel can respond to a user using this ID.
157+
:<json str message.id: The ID for the message that was received by the Channel.
158+
:<json int message.timestamp: Unix timestamp indicating when the message was received from the user.
157159

158160
**Example response**:
159161

@@ -224,4 +226,4 @@ A in-memory cache that stores the last inbound message for each user. This is us
224226
In memory state cache
225227
"""""""""""""""""""""
226228

227-
See `Message Caches <../message_caches.rst>`_ for more information.
229+
See `Message Caches <../message_caches.rst>`_ for more information.

docs/config.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ the previous layer. These layers are, in order of highest to lowest priority:
88
#. :ref:`environment-variables`
99
#. :ref:`configuration-file`
1010

11+
.. py:currentmodule:: vumi2.config
12+
1113
.. _base-worker-configuration:
1214

1315
Base worker configuration

docs/message_caches.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ Message Caches
33

44
A message cache will store messages and events to be retrieved at a later stage. Currently it's only being used for the :ref:`to-address-router`, to store outbound messages to reference at a later stage, to route events.
55

6+
.. py:currentmodule:: vumi2.message_caches
7+
68
.. _memory-message-cache:
79

810
Memory Message Cache

docs/routers.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ Routers
44
Routers manage moving messages between transports and applications according to a
55
specified set of rules.
66

7+
.. py:currentmodule:: vumi2.routers
8+
79
.. _to-address-router:
810

911
To address router

docs/transports/smpp.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,14 @@ This transport is an `SMPP 3.4`_ client, mostly used for SMS.
44

55
.. _SMPP 3.4: https://support.nowsms.com/discus/messages/1/SMPP_v3_4_Issue1_2-24857.pdf
66

7+
.. py:currentmodule:: vumi2.transports.smpp
78
89
Configuration
910
^^^^^^^^^^^^^
1011
The transport has the following configuration options:
1112

1213
All the configuration items from the base worker, which you can find at :ref:`base-worker-configuration`
1314

14-
.. py:currentmodule:: vumi2.transports.smpp
15-
1615
.. py:data:: transport_name
1716
:type: str
1817

0 commit comments

Comments
 (0)