From ed2a56de423f016f303f646cb9190b345961abbe Mon Sep 17 00:00:00 2001 From: Fabio Manganiello Date: Fri, 20 Oct 2023 00:00:07 +0200 Subject: [PATCH] `paho.mqtt` should also be added to the mock modules --- README.md | 50 ++++++++++++++++----------------- docs/source/conf.py | 5 ++-- platypush/utils/mock/modules.py | 1 + 3 files changed, 29 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index b7bd0f98..ca567b31 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,6 @@ Platypush -- [Useful links](#useful-links) - [Introduction](#introduction) + [What it can do](#what-it-can-do) - [Installation](#installation) @@ -46,34 +45,11 @@ Platypush + [PWA support](#pwa-support) - [Mobile app](#mobile-app) - [Tests](#tests) +- [Useful links](#useful-links) - [Funding](#funding) -## Useful links -- Recommended read: [**Getting started with Platypush**](https://blog.platypush.tech/article/Ultimate-self-hosted-automation-with-Platypush). - -- The [blog](https://blog.platypush.tech) is a good place to get more insights - and inspiration on what you can build. - -- The [wiki](https://git.platypush.tech/platypush/platypush/wiki) also - contains many resources on getting started. - -- Extensive documentation for all the available integrations and messages [is - available](https://docs.platypush.tech/). - -- If you have issues/feature requests/enhancements please [create an - issue](https://git.platypush.tech/platypush/platypush/issues). - -- A [Matrix instance](https://matrix.to/#/#platypush:matrix.platypush.tech) is - available if you are looking for interactive support. - -- An IRC channel is also available at `#platypush@irc.platypush.tech:6697` (SSL - only). - -- A [Lemmy instance](https://lemmy.platypush.tech/c/platypush) is available for - general questions. - ## Introduction Platypush is a general-purpose extensible platform for automation across @@ -812,6 +788,30 @@ of Platypush to your fingertips. To run the tests simply run `pytest` either from the project root folder or the `tests/` folder. +## Useful links +- Recommended read: [**Getting started with Platypush**](https://blog.platypush.tech/article/Ultimate-self-hosted-automation-with-Platypush). + +- The [blog](https://blog.platypush.tech) is a good place to get more insights + and inspiration on what you can build. + +- The [wiki](https://git.platypush.tech/platypush/platypush/wiki) also + contains many resources on getting started. + +- Extensive documentation for all the available integrations and messages [is + available](https://docs.platypush.tech/). + +- If you have issues/feature requests/enhancements please [create an + issue](https://git.platypush.tech/platypush/platypush/issues). + +- A [Matrix instance](https://matrix.to/#/#platypush:matrix.platypush.tech) is + available if you are looking for interactive support. + +- An IRC channel is also available at `#platypush@irc.platypush.tech:6697` (SSL + only). + +- A [Lemmy instance](https://lemmy.platypush.tech/c/platypush) is available for + general questions. + --- ## Funding diff --git a/docs/source/conf.py b/docs/source/conf.py index bf50c678..a1360950 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -40,6 +40,7 @@ release = '' # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ + 'myst_parser', 'sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', @@ -58,8 +59,8 @@ templates_path = ['_templates'] # The suffix(es) of source filenames. # You can specify multiple suffix as a list of string: # -# source_suffix = ['.rst', '.md'] -source_suffix = '.rst' +source_suffix = ['.rst', '.md'] +# source_suffix = '.rst' # The master toctree document. master_doc = 'index' diff --git a/platypush/utils/mock/modules.py b/platypush/utils/mock/modules.py index 0f03df53..a84299ac 100644 --- a/platypush/utils/mock/modules.py +++ b/platypush/utils/mock/modules.py @@ -69,6 +69,7 @@ mock_imports = [ "oauth2client", "omxplayer", "openzwave", + "paho.mqtt", "pandas", "paramiko", "picamera",