Fixed auto-generated docs indentation and code blocks

This commit is contained in:
Fabio Manganiello 2020-08-31 17:39:42 +02:00
parent e533484505
commit 3c3ee09d90
13 changed files with 278 additions and 298 deletions

View file

@ -1,5 +0,0 @@
``platypush.message.event``
===========================
.. automodule:: platypush.message.event
:members:

View file

@ -1,5 +0,0 @@
``platypush.plugins.stt.picovoice``
===================================
.. automodule:: platypush.plugins.stt.picovoice
:members:

View file

@ -1,5 +0,0 @@
``platypush.message.response.deepspeech``
=========================================
.. automodule:: platypush.message.response.deepspeech
:members:

View file

@ -40,20 +40,15 @@ class LcdI2cPlugin(LcdPlugin):
:param i2c_expander: Set your I²C chip type. Supported: "PCF8574", "MCP23008", "MCP23017". :param i2c_expander: Set your I²C chip type. Supported: "PCF8574", "MCP23008", "MCP23017".
:param address: The I2C address of your LCD. :param address: The I2C address of your LCD.
:param expander_params: Parameters for expanders, in a dictionary. Only needed for MCP23017 :param expander_params: Parameters for expanders, in a dictionary. Only needed for MCP23017
gpio_bank - This must be either ``A`` or ``B`` gpio_bank - This must be either ``A`` or ``B``. If you have a HAT, A is usually marked 1 and B is 2.
If you have a HAT, A is usually marked 1 and B is 2.
Example: ``expander_params={'gpio_bank': 'A'}`` Example: ``expander_params={'gpio_bank': 'A'}``
:param port: The I2C port number. Default: ``1``. :param port: The I2C port number. Default: ``1``.
:param cols: Number of columns per row (usually 16 or 20). Default: ``16``. :param cols: Number of columns per row (usually 16 or 20). Default: ``16``.
:param rows: Number of display rows (usually 1, 2 or 4). Default: ``2``. :param rows: Number of display rows (usually 1, 2 or 4). Default: ``2``.
:param backlight_enabled: Whether the backlight is enabled initially. :param backlight_enabled: Whether the backlight is enabled initially. Default: ``True``. Has no effect if pin_backlight is ``None``
Default: ``True``. Has no effect if pin_backlight is ``None`` :param dotsize: Some 1 line displays allow a font height of 10px. Allowed: ``8`` or ``10``. Default: ``8``.
:param dotsize: Some 1 line displays allow a font height of 10px. :param charmap: The character map used. Depends on your LCD. This must be either ``A00`` or ``A02`` or ``ST0B``. Default: ``A02``.
Allowed: ``8`` or ``10``. Default: ``8``. :param auto_linebreaks: Whether or not to automatically insert line breaks. Default: ``True``.
:param charmap: The character map used. Depends on your LCD. This must
be either ``A00`` or ``A02`` or ``ST0B``. Default: ``A02``.
:param auto_linebreaks: Whether or not to automatically insert line
breaks. Default: ``True``.
""" """
super().__init__(**kwargs) super().__init__(**kwargs)

View file

@ -712,8 +712,7 @@ class TensorflowPlugin(Plugin):
Fraction of the training data to be used as validation data. The model will set apart this fraction Fraction of the training data to be used as validation data. The model will set apart this fraction
of the training data, will not train on it, and will evaluate the loss and any model metrics on this data of the training data, will not train on it, and will evaluate the loss and any model metrics on this data
at the end of each epoch. The validation data is selected from the last samples in the ``x`` and ``y`` at the end of each epoch. The validation data is selected from the last samples in the ``x`` and ``y``
data provided, before shuffling. This argument is not supported when ``x`` is a dataset, generator or data provided, before shuffling. Not supported when ``x`` is a dataset, generator or ``keras.utils.Sequence`` instance.
``keras.utils.Sequence`` instance.
:param validation_data: Data on which to evaluate the loss and any model metrics at the end of each epoch. :param validation_data: Data on which to evaluate the loss and any model metrics at the end of each epoch.
The model will not be trained on this data. ``validation_data`` will override ``validation_split``. The model will not be trained on this data. ``validation_data`` will override ``validation_split``.

View file

@ -84,9 +84,9 @@ class TwilioPlugin(Plugin):
"MMS": false, "MMS": false,
"fax": false "fax": false
} }
}, }
...
] ]
""" """
phone_numbers = self.client.available_phone_numbers(country.upper()).fetch() phone_numbers = self.client.available_phone_numbers(country.upper()).fetch()
resp = requests.get(self._api_base_url + phone_numbers.uri, auth=(self.account_sid, self.auth_token)).json() resp = requests.get(self._api_base_url + phone_numbers.uri, auth=(self.account_sid, self.auth_token)).json()
@ -372,6 +372,7 @@ class TwilioPlugin(Plugin):
"to": "+18182008801", "to": "+18182008801",
"uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Messages/SMded05904ccb347238880ca9264e8fe1c.json" "uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Messages/SMded05904ccb347238880ca9264e8fe1c.json"
} }
""" """
if to in self.address_book: if to in self.address_book:
to = self.address_book[to] to = self.address_book[to]

View file

@ -813,7 +813,7 @@ class ZwavePlugin(Plugin):
Add a value to a scene. Add a value to a scene.
WARNING: This method actually doesn't work, by own admission of the WARNING: This method actually doesn't work, by own admission of the
:ref:`OpenZWave developer <https://github.com/OpenZWave/python-openzwave/blob/master/src-lib/libopenzwave/libopenzwave.pyx#L4730>`_ `OpenZWave developer <https://github.com/OpenZWave/python-openzwave/blob/master/src-lib/libopenzwave/libopenzwave.pyx#L4730>`_.
:param data: Data to set for the value (default: current value data). :param data: Data to set for the value (default: current value data).