From 008fce70fa34a8931303e685dbc6a072aa1ce48a Mon Sep 17 00:00:00 2001 From: Fabio Manganiello Date: Tue, 16 Jul 2019 23:00:20 +0200 Subject: [PATCH] Replaced references to in pydoc with format, as doesn't seem to work in RTD --- platypush/plugins/assistant/google/pushtotalk.py | 2 -- platypush/plugins/http/webpage.py | 8 +++----- platypush/plugins/light/hue/__init__.py | 4 ++-- platypush/plugins/utils.py | 12 ++++++------ 4 files changed, 11 insertions(+), 15 deletions(-) diff --git a/platypush/plugins/assistant/google/pushtotalk.py b/platypush/plugins/assistant/google/pushtotalk.py index 9523966e..e24b7995 100644 --- a/platypush/plugins/assistant/google/pushtotalk.py +++ b/platypush/plugins/assistant/google/pushtotalk.py @@ -201,8 +201,6 @@ class AssistantGooglePushtotalkPlugin(AssistantPlugin): :returns: A list of the interactions that happen within the conversation. - ..code-block:: json - [ { "request": "request 1", diff --git a/platypush/plugins/http/webpage.py b/platypush/plugins/http/webpage.py index d3e6c45e..38fad1e5 100644 --- a/platypush/plugins/http/webpage.py +++ b/platypush/plugins/http/webpage.py @@ -34,9 +34,9 @@ class HttpWebpagePlugin(Plugin): :param outfile: If set then the output will be written to the specified file (supported formats: pdf, html, plain (default)). The plugin will guess the format from the extension - :return: dict. Example if outfile is not specified + :return: dict - ..code-block:: json + Example if outfile is not specified:: { "url": , @@ -45,9 +45,7 @@ class HttpWebpagePlugin(Plugin): } - Example if outfile is specified: - - ..code-block:: json + Example if outfile is specified:: { "url": , diff --git a/platypush/plugins/light/hue/__init__.py b/platypush/plugins/light/hue/__init__.py index ade90952..b0fb8af3 100644 --- a/platypush/plugins/light/hue/__init__.py +++ b/platypush/plugins/light/hue/__init__.py @@ -255,9 +255,9 @@ class LightHuePlugin(LightPlugin): """ Get the list of running light animations. - :returns: A dictionary with the following structure. + :returns: dict. - .code-block:: json + Structure:: { "groups": { diff --git a/platypush/plugins/utils.py b/platypush/plugins/utils.py index eaeb54e5..e37bc247 100644 --- a/platypush/plugins/utils.py +++ b/platypush/plugins/utils.py @@ -105,9 +105,9 @@ class UtilsPlugin(Plugin): """ Get info about the pending timeouts - :returns: dict. Example: + :returns: dict. - .. code-block:: json + Example:: { "test_timeout": { @@ -139,9 +139,9 @@ class UtilsPlugin(Plugin): :param name: Name of the timeout to get :type name: str - :returns: dict. Example: + :returns: dict - .. code-block:: json + Example:: { "test_timeout": { @@ -248,9 +248,9 @@ class UtilsPlugin(Plugin): """ Get info about the running intervals - :returns: dict. Example: + :returns: dict - .. code-block:: json + Example:: { "test_interval": {