deploy: db67c14

empicano · Dec 26, 2023 · 8a7e5d7 · 8a7e5d7
1 parent 1fc0d63
commit 8a7e5d7
Show file tree

Hide file tree

Showing 17 changed files with 14 additions and 3 deletions.
diff --git a/.doctrees/connecting-to-the-broker.doctree b/.doctrees/connecting-to-the-broker.doctree
diff --git a/.doctrees/developer-interface.doctree b/.doctrees/developer-interface.doctree
diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle
diff --git a/.doctrees/index.doctree b/.doctrees/index.doctree
diff --git a/_sources/connecting-to-the-broker.md.txt b/_sources/connecting-to-the-broker.md.txt
@@ -24,7 +24,7 @@ If your use case does not allow you to use a context manager, you can use the cl
 ```
 
 ```{note}
-Examples use the public [mosquitto test broker](https://test.mosquitto.org/). You can connect to this broker without any credentials. Alternatively, you can spin up a local mosquitto broker with Docker via `./scripts/develop` and connect with `aiomqtt.Client("localhost", port=1883)`.
+Examples use the public [mosquitto test broker](https://test.mosquitto.org/). You can connect to this broker without any credentials. Alternatively, our [contribution guide](https://github.com/sbtinstruments/aiomqtt/blob/main/CONTRIBUTING.md) contains an explanation of how to spin up a local mosquitto broker with Docker.
 
 All examples in this documentation are self-contained and runnable as-is.
 ```

diff --git a/_sources/index.md.txt b/_sources/index.md.txt
@@ -40,5 +40,6 @@ developer-interface
 GitHub <https://github.com/sbtinstruments/aiomqtt>
 Issue tracker <https://github.com/sbtinstruments/aiomqtt/issues>
 Discussions <https://github.com/sbtinstruments/aiomqtt/discussions>
+Contributing <https://github.com/sbtinstruments/aiomqtt/blob/main/CONTRIBUTING.md>
 PyPI <https://pypi.org/project/aiomqtt/>
 ```
diff --git a/alongside-fastapi-and-co.html b/alongside-fastapi-and-co.html
@@ -175,6 +175,7 @@
 <li class="toctree-l1"><a class="reference external" href="https://github.com/sbtinstruments/aiomqtt">GitHub</a></li>
 <li class="toctree-l1"><a class="reference external" href="https://github.com/sbtinstruments/aiomqtt/issues">Issue tracker</a></li>
 <li class="toctree-l1"><a class="reference external" href="https://github.com/sbtinstruments/aiomqtt/discussions">Discussions</a></li>
+<li class="toctree-l1"><a class="reference external" href="https://github.com/sbtinstruments/aiomqtt/blob/main/CONTRIBUTING.md">Contributing</a></li>
 <li class="toctree-l1"><a class="reference external" href="https://pypi.org/project/aiomqtt/">PyPI</a></li>
 </ul>
 

diff --git a/connecting-to-the-broker.html b/connecting-to-the-broker.html
@@ -175,6 +175,7 @@
 <li class="toctree-l1"><a class="reference external" href="https://github.com/sbtinstruments/aiomqtt">GitHub</a></li>
 <li class="toctree-l1"><a class="reference external" href="https://github.com/sbtinstruments/aiomqtt/issues">Issue tracker</a></li>
 <li class="toctree-l1"><a class="reference external" href="https://github.com/sbtinstruments/aiomqtt/discussions">Discussions</a></li>
+<li class="toctree-l1"><a class="reference external" href="https://github.com/sbtinstruments/aiomqtt/blob/main/CONTRIBUTING.md">Contributing</a></li>
 <li class="toctree-l1"><a class="reference external" href="https://pypi.org/project/aiomqtt/">PyPI</a></li>
 </ul>
 
@@ -233,7 +234,7 @@ <h1>Connecting to the broker<a class="headerlink" href="#connecting-to-the-broke
 </div>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
-<p>Examples use the public <a class="reference external" href="https://test.mosquitto.org/">mosquitto test broker</a>. You can connect to this broker without any credentials. Alternatively, you can spin up a local mosquitto broker with Docker via <code class="docutils literal notranslate"><span class="pre">./scripts/develop</span></code> and connect with <code class="docutils literal notranslate"><span class="pre">aiomqtt.Client(&quot;localhost&quot;,</span> <span class="pre">port=1883)</span></code>.</p>
+<p>Examples use the public <a class="reference external" href="https://test.mosquitto.org/">mosquitto test broker</a>. You can connect to this broker without any credentials. Alternatively, our <a class="reference external" href="https://github.com/sbtinstruments/aiomqtt/blob/main/CONTRIBUTING.md">contribution guide</a> contains an explanation of how to spin up a local mosquitto broker with Docker.</p>
 <p>All examples in this documentation are self-contained and runnable as-is.</p>
 </div>
 <p>For a list of all available arguments to the client, see the <a class="reference internal" href="developer-interface.html"><span class="doc std std-doc">API reference</span></a>.</p>

diff --git a/developer-interface.html b/developer-interface.html
@@ -175,6 +175,7 @@
 <li class="toctree-l1"><a class="reference external" href="https://github.com/sbtinstruments/aiomqtt">GitHub</a></li>
 <li class="toctree-l1"><a class="reference external" href="https://github.com/sbtinstruments/aiomqtt/issues">Issue tracker</a></li>
 <li class="toctree-l1"><a class="reference external" href="https://github.com/sbtinstruments/aiomqtt/discussions">Discussions</a></li>
+<li class="toctree-l1"><a class="reference external" href="https://github.com/sbtinstruments/aiomqtt/blob/main/CONTRIBUTING.md">Contributing</a></li>
 <li class="toctree-l1"><a class="reference external" href="https://pypi.org/project/aiomqtt/">PyPI</a></li>
 </ul>
 

diff --git a/genindex.html b/genindex.html
@@ -173,6 +173,7 @@
 <li class="toctree-l1"><a class="reference external" href="https://github.com/sbtinstruments/aiomqtt">GitHub</a></li>
 <li class="toctree-l1"><a class="reference external" href="https://github.com/sbtinstruments/aiomqtt/issues">Issue tracker</a></li>
 <li class="toctree-l1"><a class="reference external" href="https://github.com/sbtinstruments/aiomqtt/discussions">Discussions</a></li>
+<li class="toctree-l1"><a class="reference external" href="https://github.com/sbtinstruments/aiomqtt/blob/main/CONTRIBUTING.md">Contributing</a></li>
 <li class="toctree-l1"><a class="reference external" href="https://pypi.org/project/aiomqtt/">PyPI</a></li>
 </ul>
 

diff --git a/index.html b/index.html
@@ -175,6 +175,7 @@
 <li class="toctree-l1"><a class="reference external" href="https://github.com/sbtinstruments/aiomqtt">GitHub</a></li>
 <li class="toctree-l1"><a class="reference external" href="https://github.com/sbtinstruments/aiomqtt/issues">Issue tracker</a></li>
 <li class="toctree-l1"><a class="reference external" href="https://github.com/sbtinstruments/aiomqtt/discussions">Discussions</a></li>
+<li class="toctree-l1"><a class="reference external" href="https://github.com/sbtinstruments/aiomqtt/blob/main/CONTRIBUTING.md">Contributing</a></li>
 <li class="toctree-l1"><a class="reference external" href="https://pypi.org/project/aiomqtt/">PyPI</a></li>
 </ul>
 

diff --git a/introduction.html b/introduction.html
@@ -175,6 +175,7 @@
 <li class="toctree-l1"><a class="reference external" href="https://github.com/sbtinstruments/aiomqtt">GitHub</a></li>
 <li class="toctree-l1"><a class="reference external" href="https://github.com/sbtinstruments/aiomqtt/issues">Issue tracker</a></li>
 <li class="toctree-l1"><a class="reference external" href="https://github.com/sbtinstruments/aiomqtt/discussions">Discussions</a></li>
+<li class="toctree-l1"><a class="reference external" href="https://github.com/sbtinstruments/aiomqtt/blob/main/CONTRIBUTING.md">Contributing</a></li>
 <li class="toctree-l1"><a class="reference external" href="https://pypi.org/project/aiomqtt/">PyPI</a></li>
 </ul>
 

diff --git a/publishing-a-message.html b/publishing-a-message.html
@@ -175,6 +175,7 @@
 <li class="toctree-l1"><a class="reference external" href="https://github.com/sbtinstruments/aiomqtt">GitHub</a></li>
 <li class="toctree-l1"><a class="reference external" href="https://github.com/sbtinstruments/aiomqtt/issues">Issue tracker</a></li>
 <li class="toctree-l1"><a class="reference external" href="https://github.com/sbtinstruments/aiomqtt/discussions">Discussions</a></li>
+<li class="toctree-l1"><a class="reference external" href="https://github.com/sbtinstruments/aiomqtt/blob/main/CONTRIBUTING.md">Contributing</a></li>
 <li class="toctree-l1"><a class="reference external" href="https://pypi.org/project/aiomqtt/">PyPI</a></li>
 </ul>
 

diff --git a/reconnection.html b/reconnection.html
@@ -175,6 +175,7 @@
 <li class="toctree-l1"><a class="reference external" href="https://github.com/sbtinstruments/aiomqtt">GitHub</a></li>
 <li class="toctree-l1"><a class="reference external" href="https://github.com/sbtinstruments/aiomqtt/issues">Issue tracker</a></li>
 <li class="toctree-l1"><a class="reference external" href="https://github.com/sbtinstruments/aiomqtt/discussions">Discussions</a></li>
+<li class="toctree-l1"><a class="reference external" href="https://github.com/sbtinstruments/aiomqtt/blob/main/CONTRIBUTING.md">Contributing</a></li>
 <li class="toctree-l1"><a class="reference external" href="https://pypi.org/project/aiomqtt/">PyPI</a></li>
 </ul>
 

diff --git a/search.html b/search.html
@@ -172,6 +172,7 @@
 <li class="toctree-l1"><a class="reference external" href="https://github.com/sbtinstruments/aiomqtt">GitHub</a></li>
 <li class="toctree-l1"><a class="reference external" href="https://github.com/sbtinstruments/aiomqtt/issues">Issue tracker</a></li>
 <li class="toctree-l1"><a class="reference external" href="https://github.com/sbtinstruments/aiomqtt/discussions">Discussions</a></li>
+<li class="toctree-l1"><a class="reference external" href="https://github.com/sbtinstruments/aiomqtt/blob/main/CONTRIBUTING.md">Contributing</a></li>
 <li class="toctree-l1"><a class="reference external" href="https://pypi.org/project/aiomqtt/">PyPI</a></li>
 </ul>