forked from platypush/platypush
Replaced references to in pydoc with format, as doesn't seem to work in RTD
This commit is contained in:
parent
a60e89806f
commit
008fce70fa
4 changed files with 11 additions and 15 deletions
|
@ -201,8 +201,6 @@ class AssistantGooglePushtotalkPlugin(AssistantPlugin):
|
||||||
|
|
||||||
:returns: A list of the interactions that happen within the conversation.
|
:returns: A list of the interactions that happen within the conversation.
|
||||||
|
|
||||||
..code-block:: json
|
|
||||||
|
|
||||||
[
|
[
|
||||||
{
|
{
|
||||||
"request": "request 1",
|
"request": "request 1",
|
||||||
|
|
|
@ -34,9 +34,9 @@ class HttpWebpagePlugin(Plugin):
|
||||||
:param outfile: If set then the output will be written to the specified file
|
:param outfile: If set then the output will be written to the specified file
|
||||||
(supported formats: pdf, html, plain (default)). The plugin will guess
|
(supported formats: pdf, html, plain (default)). The plugin will guess
|
||||||
the format from the extension
|
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": <url>,
|
"url": <url>,
|
||||||
|
@ -45,9 +45,7 @@ class HttpWebpagePlugin(Plugin):
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
Example if outfile is specified:
|
Example if outfile is specified::
|
||||||
|
|
||||||
..code-block:: json
|
|
||||||
|
|
||||||
{
|
{
|
||||||
"url": <url>,
|
"url": <url>,
|
||||||
|
|
|
@ -255,9 +255,9 @@ class LightHuePlugin(LightPlugin):
|
||||||
"""
|
"""
|
||||||
Get the list of running light animations.
|
Get the list of running light animations.
|
||||||
|
|
||||||
:returns: A dictionary with the following structure.
|
:returns: dict.
|
||||||
|
|
||||||
.code-block:: json
|
Structure::
|
||||||
|
|
||||||
{
|
{
|
||||||
"groups": {
|
"groups": {
|
||||||
|
|
|
@ -105,9 +105,9 @@ class UtilsPlugin(Plugin):
|
||||||
"""
|
"""
|
||||||
Get info about the pending timeouts
|
Get info about the pending timeouts
|
||||||
|
|
||||||
:returns: dict. Example:
|
:returns: dict.
|
||||||
|
|
||||||
.. code-block:: json
|
Example::
|
||||||
|
|
||||||
{
|
{
|
||||||
"test_timeout": {
|
"test_timeout": {
|
||||||
|
@ -139,9 +139,9 @@ class UtilsPlugin(Plugin):
|
||||||
:param name: Name of the timeout to get
|
:param name: Name of the timeout to get
|
||||||
:type name: str
|
:type name: str
|
||||||
|
|
||||||
:returns: dict. Example:
|
:returns: dict
|
||||||
|
|
||||||
.. code-block:: json
|
Example::
|
||||||
|
|
||||||
{
|
{
|
||||||
"test_timeout": {
|
"test_timeout": {
|
||||||
|
@ -248,9 +248,9 @@ class UtilsPlugin(Plugin):
|
||||||
"""
|
"""
|
||||||
Get info about the running intervals
|
Get info about the running intervals
|
||||||
|
|
||||||
:returns: dict. Example:
|
:returns: dict
|
||||||
|
|
||||||
.. code-block:: json
|
Example::
|
||||||
|
|
||||||
{
|
{
|
||||||
"test_interval": {
|
"test_interval": {
|
||||||
|
|
Loading…
Reference in a new issue