Deploy to GitHub pages

latest/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 63740f04ae1f4ade10ef51a9863488e3
+config: dd16894b589f9887b0e2d60cb87037c9
 tags: 645f666f9bcd5a90fca523b33c5a78b7

latest/api/generated/compas_eve.InMemoryTransport.advertise.html

@@ -564,7 +564,7 @@
 <h1>InMemoryTransport.advertise</h1>
 <dl class="py method">
 <dt class="sig sig-object py" id="compas_eve.InMemoryTransport.advertise">
-<span class="sig-prename descclassname"><span class="pre">InMemoryTransport.</span></span><span class="sig-name descname"><span class="pre">advertise</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">topic</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/compas-dev/compas_eve/blob/fd8ae59/src/compas_eve/memory/__init__.py#L100"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
+<span class="sig-prename descclassname"><span class="pre">InMemoryTransport.</span></span><span class="sig-name descname"><span class="pre">advertise</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">topic</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/compas-dev/compas_eve/blob/49dc280/src/compas_eve/memory/__init__.py#L100"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
 <dd><p>Announce this code will publish messages to the specified topic.</p>
 <p>This call has no effect on the in-memory transport.</p>
 </dd></dl>

latest/api/generated/compas_eve.InMemoryTransport.emit.html

@@ -564,7 +564,7 @@
 <h1>InMemoryTransport.emit</h1>
 <dl class="py method">
 <dt class="sig sig-object py" id="compas_eve.InMemoryTransport.emit">
-<span class="sig-prename descclassname"><span class="pre">InMemoryTransport.</span></span><span class="sig-name descname"><span class="pre">emit</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">event</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/compas-dev/compas_eve/blob/fd8ae59/src/compas_eve/event_emitter.py#L146"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
+<span class="sig-prename descclassname"><span class="pre">InMemoryTransport.</span></span><span class="sig-name descname"><span class="pre">emit</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">event</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/compas-dev/compas_eve/blob/49dc280/src/compas_eve/event_emitter.py#L146"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
 <dd><p>Emit <code class="docutils literal notranslate"><span class="pre">event</span></code>, passing <code class="docutils literal notranslate"><span class="pre">*args</span></code> and <code class="docutils literal notranslate"><span class="pre">**kwargs</span></code> to each attached
 function. Returns <code class="docutils literal notranslate"><span class="pre">True</span></code> if any functions are attached to <code class="docutils literal notranslate"><span class="pre">event</span></code>;
 otherwise returns <code class="docutils literal notranslate"><span class="pre">False</span></code>.</p>

latest/api/generated/compas_eve.InMemoryTransport.html

@@ -559,7 +559,7 @@
 <h1>InMemoryTransport</h1>
 <dl class="py class">
 <dt class="sig sig-object py" id="compas_eve.InMemoryTransport">
-<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">compas_eve.</span></span><span class="sig-name descname"><span class="pre">InMemoryTransport</span></span><a class="reference external" href="https://github.com/compas-dev/compas_eve/blob/fd8ae59/src/compas_eve/memory/__init__.py#L26"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">compas_eve.</span></span><span class="sig-name descname"><span class="pre">InMemoryTransport</span></span><a class="reference external" href="https://github.com/compas-dev/compas_eve/blob/49dc280/src/compas_eve/memory/__init__.py#L26"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
 <dd><p>Bases: <a class="reference internal" href="compas_eve.Transport.html#compas_eve.Transport" title="compas_eve.core.Transport"><code class="xref py py-class docutils literal notranslate"><span class="pre">Transport</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">EventEmitterMixin</span></code></p>
 <p>In-Memory transport is ideal for simple single-process apps and testing.</p>
 <p>It will only distribute messages within the same process, not across different processes.</p>

latest/api/generated/compas_eve.InMemoryTransport.listeners.html

@@ -564,7 +564,7 @@
 <h1>InMemoryTransport.listeners</h1>
 <dl class="py method">
 <dt class="sig sig-object py" id="compas_eve.InMemoryTransport.listeners">
-<span class="sig-prename descclassname"><span class="pre">InMemoryTransport.</span></span><span class="sig-name descname"><span class="pre">listeners</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">event</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/compas-dev/compas_eve/blob/fd8ae59/src/compas_eve/event_emitter.py#L242"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
+<span class="sig-prename descclassname"><span class="pre">InMemoryTransport.</span></span><span class="sig-name descname"><span class="pre">listeners</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">event</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/compas-dev/compas_eve/blob/49dc280/src/compas_eve/event_emitter.py#L250"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
 <dd><p>Returns a list of all listeners registered to the <code class="docutils literal notranslate"><span class="pre">event</span></code>.</p>
 </dd></dl>
 

latest/api/generated/compas_eve.InMemoryTransport.off.html

@@ -564,7 +564,7 @@
 <h1>InMemoryTransport.off</h1>
 <dl class="py method">
 <dt class="sig sig-object py" id="compas_eve.InMemoryTransport.off">
-<span class="sig-prename descclassname"><span class="pre">InMemoryTransport.</span></span><span class="sig-name descname"><span class="pre">off</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">event</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">f</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/compas-dev/compas_eve/blob/fd8ae59/src/compas_eve/event_emitter.py#L224"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
+<span class="sig-prename descclassname"><span class="pre">InMemoryTransport.</span></span><span class="sig-name descname"><span class="pre">off</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">event</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">f</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/compas-dev/compas_eve/blob/49dc280/src/compas_eve/event_emitter.py#L224"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
 <dd><p>Removes the function <code class="docutils literal notranslate"><span class="pre">f</span></code> from <code class="docutils literal notranslate"><span class="pre">event</span></code>.</p>
 </dd></dl>
 

latest/api/generated/compas_eve.InMemoryTransport.on.html

@@ -564,7 +564,7 @@
 <h1>InMemoryTransport.on</h1>
 <dl class="py method">
 <dt class="sig sig-object py" id="compas_eve.InMemoryTransport.on">
-<span class="sig-prename descclassname"><span class="pre">InMemoryTransport.</span></span><span class="sig-name descname"><span class="pre">on</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">event</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">f</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/compas-dev/compas_eve/blob/fd8ae59/src/compas_eve/event_emitter.py#L97"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
+<span class="sig-prename descclassname"><span class="pre">InMemoryTransport.</span></span><span class="sig-name descname"><span class="pre">on</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">event</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">f</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/compas-dev/compas_eve/blob/49dc280/src/compas_eve/event_emitter.py#L97"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
 <dd><p>Registers the function (or optionally an asyncio coroutine function)
 <code class="docutils literal notranslate"><span class="pre">f</span></code> to the event name <code class="docutils literal notranslate"><span class="pre">event</span></code>.</p>
 <p>If <code class="docutils literal notranslate"><span class="pre">f</span></code> isn’t provided, this method returns a function that

latest/api/generated/compas_eve.InMemoryTransport.on_ready.html

@@ -564,7 +564,7 @@
 <h1>InMemoryTransport.on_ready</h1>
 <dl class="py method">
 <dt class="sig sig-object py" id="compas_eve.InMemoryTransport.on_ready">
-<span class="sig-prename descclassname"><span class="pre">InMemoryTransport.</span></span><span class="sig-name descname"><span class="pre">on_ready</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">callback</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/compas-dev/compas_eve/blob/fd8ae59/src/compas_eve/memory/__init__.py#L35"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
+<span class="sig-prename descclassname"><span class="pre">InMemoryTransport.</span></span><span class="sig-name descname"><span class="pre">on_ready</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">callback</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/compas-dev/compas_eve/blob/49dc280/src/compas_eve/memory/__init__.py#L35"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
 <dd><p>In-memory transport is always ready, it will immediately trigger the callback.</p>
 </dd></dl>
 

latest/api/generated/compas_eve.InMemoryTransport.once.html

@@ -564,7 +564,7 @@
 <h1>InMemoryTransport.once</h1>
 <dl class="py method">
 <dt class="sig sig-object py" id="compas_eve.InMemoryTransport.once">
-<span class="sig-prename descclassname"><span class="pre">InMemoryTransport.</span></span><span class="sig-name descname"><span class="pre">once</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">event</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">f</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/compas-dev/compas_eve/blob/fd8ae59/src/compas_eve/event_emitter.py#L202"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
+<span class="sig-prename descclassname"><span class="pre">InMemoryTransport.</span></span><span class="sig-name descname"><span class="pre">once</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">event</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">f</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/compas-dev/compas_eve/blob/49dc280/src/compas_eve/event_emitter.py#L202"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
 <dd><p>The same as <code class="docutils literal notranslate"><span class="pre">ee.on</span></code>, except that the listener is automatically
 removed after being called.</p>
 </dd></dl>

latest/api/generated/compas_eve.InMemoryTransport.publish.html

@@ -564,7 +564,7 @@
 <h1>InMemoryTransport.publish</h1>
 <dl class="py method">
 <dt class="sig sig-object py" id="compas_eve.InMemoryTransport.publish">
-<span class="sig-prename descclassname"><span class="pre">InMemoryTransport.</span></span><span class="sig-name descname"><span class="pre">publish</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">topic</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/compas-dev/compas_eve/blob/fd8ae59/src/compas_eve/memory/__init__.py#L39"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
+<span class="sig-prename descclassname"><span class="pre">InMemoryTransport.</span></span><span class="sig-name descname"><span class="pre">publish</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">topic</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/compas-dev/compas_eve/blob/49dc280/src/compas_eve/memory/__init__.py#L39"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
 <dd><p>Publish a message to a topic.</p>
 <dl class="field-list">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>

latest/api/generated/compas_eve.InMemoryTransport.remove_all_listeners.html

@@ -564,7 +564,7 @@
 <h1>InMemoryTransport.remove_all_listeners</h1>
 <dl class="py method">
 <dt class="sig sig-object py" id="compas_eve.InMemoryTransport.remove_all_listeners">
-<span class="sig-prename descclassname"><span class="pre">InMemoryTransport.</span></span><span class="sig-name descname"><span class="pre">remove_all_listeners</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">event</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/compas-dev/compas_eve/blob/fd8ae59/src/compas_eve/event_emitter.py#L232"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
+<span class="sig-prename descclassname"><span class="pre">InMemoryTransport.</span></span><span class="sig-name descname"><span class="pre">remove_all_listeners</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">event</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/compas-dev/compas_eve/blob/49dc280/src/compas_eve/event_emitter.py#L240"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
 <dd><p>Remove all listeners attached to <code class="docutils literal notranslate"><span class="pre">event</span></code>.
 If <code class="docutils literal notranslate"><span class="pre">event</span></code> is <code class="docutils literal notranslate"><span class="pre">None</span></code>, remove all listeners on all events.</p>
 </dd></dl>

latest/api/generated/compas_eve.InMemoryTransport.remove_listener.html

@@ -564,7 +564,7 @@
 <h1>InMemoryTransport.remove_listener</h1>
 <dl class="py method">
 <dt class="sig sig-object py" id="compas_eve.InMemoryTransport.remove_listener">
-<span class="sig-prename descclassname"><span class="pre">InMemoryTransport.</span></span><span class="sig-name descname"><span class="pre">remove_listener</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">event</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">f</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/compas-dev/compas_eve/blob/fd8ae59/src/compas_eve/event_emitter.py#L228"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
+<span class="sig-prename descclassname"><span class="pre">InMemoryTransport.</span></span><span class="sig-name descname"><span class="pre">remove_listener</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">event</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">f</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/compas-dev/compas_eve/blob/49dc280/src/compas_eve/event_emitter.py#L232"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
 <dd><p>Removes the function <code class="docutils literal notranslate"><span class="pre">f</span></code> from <code class="docutils literal notranslate"><span class="pre">event</span></code>.</p>
 </dd></dl>
 

latest/api/generated/compas_eve.InMemoryTransport.subscribe.html

@@ -564,7 +564,7 @@
 <h1>InMemoryTransport.subscribe</h1>
 <dl class="py method">
 <dt class="sig sig-object py" id="compas_eve.InMemoryTransport.subscribe">
-<span class="sig-prename descclassname"><span class="pre">InMemoryTransport.</span></span><span class="sig-name descname"><span class="pre">subscribe</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">topic</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">callback</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/compas-dev/compas_eve/blob/fd8ae59/src/compas_eve/memory/__init__.py#L56"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
+<span class="sig-prename descclassname"><span class="pre">InMemoryTransport.</span></span><span class="sig-name descname"><span class="pre">subscribe</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">topic</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">callback</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/compas-dev/compas_eve/blob/49dc280/src/compas_eve/memory/__init__.py#L56"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
 <dd><p>Subscribe to a topic.</p>
 <p>Every time a new message is received on the topic, the callback will be invoked.</p>
 <dl class="field-list">