Skip to content

Commit

Permalink
Build docs for release of 1.3.0a6 [ci skip]
Browse files Browse the repository at this point in the history
  • Loading branch information
@adamcharnock
adamcharnock committed Mar 24, 2024
1 parent af1c67e commit 6773d12
Show file tree
Hide file tree
Showing 7 changed files with 65 additions and 65 deletions.
2 changes: 1 addition & 1 deletion v1.3/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1248,7 +1248,7 @@
<h1 id="what-is-lightbus">What is Lightbus?<a class="headerlink" href="#what-is-lightbus" title="Permanent link">&para;</a></h1>
<p>Lightbus is a powerful and intuitive messaging client for your
backend Python services.</p>
<p>Lightbus uses Redis 5 as its underlying <a href="explanation/transports/">transport</a>, although support
<p>Lightbus uses Redis as its underlying <a href="explanation/transports/">transport</a>, although support
for other platforms will be added in future.</p>
<p>Other languages can also communicate with Lightbus by
<a href="reference/protocols/">interacting with Redis</a>.</p>
Expand Down
4 changes: 2 additions & 2 deletions v1.3/reference/release-process/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1166,8 +1166,8 @@ <h1 id="lightbus-release-process">Lightbus release process<a class="headerlink"
<span class="c1"># Version bump</span>
poetry<span class="w"> </span>version<span class="w"> </span><span class="o">{</span>patch,minor,major,prepatch,preminor,premajor,prerelease<span class="o">}</span>

<span class="nb">export</span><span class="w"> </span><span class="nv">VERSION</span><span class="o">=</span><span class="k">$(</span>lightbus<span class="w"> </span>version<span class="w"> </span>--pyproject<span class="k">)</span><span class="w"> </span><span class="c1"># v1.2.3</span>
<span class="nb">export</span><span class="w"> </span><span class="nv">VERSION_DOCS</span><span class="o">=</span><span class="k">$(</span>lightbus<span class="w"> </span>version<span class="w"> </span>--pyproject<span class="w"> </span>--docs<span class="k">)</span><span class="w"> </span><span class="c1"># v1.2</span>
<span class="nb">export</span><span class="w"> </span><span class="nv">VERSION</span><span class="o">=(</span>lightbus<span class="w"> </span>version<span class="w"> </span>--pyproject<span class="o">)</span><span class="w"> </span><span class="c1"># v1.2.3</span>
<span class="nb">export</span><span class="w"> </span><span class="nv">VERSION_DOCS</span><span class="o">=(</span>lightbus<span class="w"> </span>version<span class="w"> </span>--pyproject<span class="w"> </span>--docs<span class="o">)</span><span class="w"> </span><span class="c1"># v1.2</span>

<span class="c1"># Commit</span>
git<span class="w"> </span>add<span class="w"> </span>.
Expand Down
2 changes: 1 addition & 1 deletion v1.3/search/search_index.json
View file

Large diffs are not rendered by default.

114 changes: 57 additions & 57 deletions v1.3/sitemap.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,287 +2,287 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>http://lightbus.org/v1.3/</loc>
<lastmod>2023-08-17</lastmod>
<lastmod>2024-03-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://lightbus.org/v1.3/CODE_OF_CONDUCT/</loc>
<lastmod>2023-08-17</lastmod>
<lastmod>2024-03-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://lightbus.org/v1.3/explanation/</loc>
<lastmod>2023-08-17</lastmod>
<lastmod>2024-03-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://lightbus.org/v1.3/explanation/anatomy-lesson/</loc>
<lastmod>2023-08-17</lastmod>
<lastmod>2024-03-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://lightbus.org/v1.3/explanation/apis/</loc>
<lastmod>2023-08-17</lastmod>
<lastmod>2024-03-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://lightbus.org/v1.3/explanation/architecture-tips/</loc>
<lastmod>2023-08-17</lastmod>
<lastmod>2024-03-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://lightbus.org/v1.3/explanation/bus/</loc>
<lastmod>2023-08-17</lastmod>
<lastmod>2024-03-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://lightbus.org/v1.3/explanation/configuration/</loc>
<lastmod>2023-08-17</lastmod>
<lastmod>2024-03-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://lightbus.org/v1.3/explanation/events/</loc>
<lastmod>2023-08-17</lastmod>
<lastmod>2024-03-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://lightbus.org/v1.3/explanation/internal-architecture/</loc>
<lastmod>2023-08-17</lastmod>
<lastmod>2024-03-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://lightbus.org/v1.3/explanation/lightbus-vs-celery/</loc>
<lastmod>2023-08-17</lastmod>
<lastmod>2024-03-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://lightbus.org/v1.3/explanation/marshalling/</loc>
<lastmod>2023-08-17</lastmod>
<lastmod>2024-03-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://lightbus.org/v1.3/explanation/performance/</loc>
<lastmod>2023-08-17</lastmod>
<lastmod>2024-03-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://lightbus.org/v1.3/explanation/rpcs/</loc>
<lastmod>2023-08-17</lastmod>
<lastmod>2024-03-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://lightbus.org/v1.3/explanation/schema/</loc>
<lastmod>2023-08-17</lastmod>
<lastmod>2024-03-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://lightbus.org/v1.3/explanation/services/</loc>
<lastmod>2023-08-17</lastmod>
<lastmod>2024-03-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://lightbus.org/v1.3/explanation/transports/</loc>
<lastmod>2023-08-17</lastmod>
<lastmod>2024-03-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://lightbus.org/v1.3/howto/</loc>
<lastmod>2023-08-17</lastmod>
<lastmod>2024-03-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://lightbus.org/v1.3/howto/access-your-bus-client/</loc>
<lastmod>2023-08-17</lastmod>
<lastmod>2024-03-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://lightbus.org/v1.3/howto/event-sourcing/</loc>
<lastmod>2023-08-17</lastmod>
<lastmod>2024-03-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://lightbus.org/v1.3/howto/metrics/</loc>
<lastmod>2023-08-17</lastmod>
<lastmod>2024-03-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://lightbus.org/v1.3/howto/migrate-from-celery-to-lightbus/</loc>
<lastmod>2023-08-17</lastmod>
<lastmod>2024-03-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://lightbus.org/v1.3/howto/modify-lightbus/</loc>
<lastmod>2023-08-17</lastmod>
<lastmod>2024-03-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://lightbus.org/v1.3/howto/run-background-tasks/</loc>
<lastmod>2023-08-17</lastmod>
<lastmod>2024-03-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://lightbus.org/v1.3/howto/schedule-recurring-tasks/</loc>
<lastmod>2023-08-17</lastmod>
<lastmod>2024-03-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://lightbus.org/v1.3/howto/write-idempotent-event-handlers/</loc>
<lastmod>2023-08-17</lastmod>
<lastmod>2024-03-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://lightbus.org/v1.3/includes/if-you-get-stuck/</loc>
<lastmod>2023-08-17</lastmod>
<lastmod>2024-03-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://lightbus.org/v1.3/includes/note-configuration-auto-complete/</loc>
<lastmod>2023-08-17</lastmod>
<lastmod>2024-03-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://lightbus.org/v1.3/reference/</loc>
<lastmod>2023-08-17</lastmod>
<lastmod>2024-03-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://lightbus.org/v1.3/reference/apis/</loc>
<lastmod>2023-08-17</lastmod>
<lastmod>2024-03-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://lightbus.org/v1.3/reference/authors/</loc>
<lastmod>2023-08-17</lastmod>
<lastmod>2024-03-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://lightbus.org/v1.3/reference/code-of-conduct/</loc>
<lastmod>2023-08-17</lastmod>
<lastmod>2024-03-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://lightbus.org/v1.3/reference/configuration/</loc>
<lastmod>2023-08-17</lastmod>
<lastmod>2024-03-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://lightbus.org/v1.3/reference/events/</loc>
<lastmod>2023-08-17</lastmod>
<lastmod>2024-03-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://lightbus.org/v1.3/reference/plugins-development/</loc>
<lastmod>2023-08-17</lastmod>
<lastmod>2024-03-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://lightbus.org/v1.3/reference/plugins/</loc>
<lastmod>2023-08-17</lastmod>
<lastmod>2024-03-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://lightbus.org/v1.3/reference/release-process/</loc>
<lastmod>2023-08-17</lastmod>
<lastmod>2024-03-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://lightbus.org/v1.3/reference/rpcs/</loc>
<lastmod>2023-08-17</lastmod>
<lastmod>2024-03-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://lightbus.org/v1.3/reference/schema/</loc>
<lastmod>2023-08-17</lastmod>
<lastmod>2024-03-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://lightbus.org/v1.3/reference/testing-and-mocking/</loc>
<lastmod>2023-08-17</lastmod>
<lastmod>2024-03-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://lightbus.org/v1.3/reference/transport-configuration/</loc>
<lastmod>2023-08-17</lastmod>
<lastmod>2024-03-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://lightbus.org/v1.3/reference/typing/</loc>
<lastmod>2023-08-17</lastmod>
<lastmod>2024-03-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://lightbus.org/v1.3/reference/command-line-use/dumpconfigschema/</loc>
<lastmod>2023-08-17</lastmod>
<lastmod>2024-03-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://lightbus.org/v1.3/reference/command-line-use/dumpschema/</loc>
<lastmod>2023-08-17</lastmod>
<lastmod>2024-03-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://lightbus.org/v1.3/reference/command-line-use/inspect/</loc>
<lastmod>2023-08-17</lastmod>
<lastmod>2024-03-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://lightbus.org/v1.3/reference/command-line-use/run/</loc>
<lastmod>2023-08-17</lastmod>
<lastmod>2024-03-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://lightbus.org/v1.3/reference/command-line-use/shell/</loc>
<lastmod>2023-08-17</lastmod>
<lastmod>2024-03-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://lightbus.org/v1.3/reference/protocols/</loc>
<lastmod>2023-08-17</lastmod>
<lastmod>2024-03-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://lightbus.org/v1.3/reference/protocols/event/</loc>
<lastmod>2023-08-17</lastmod>
<lastmod>2024-03-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://lightbus.org/v1.3/reference/protocols/rpc-and-result/</loc>
<lastmod>2023-08-17</lastmod>
<lastmod>2024-03-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://lightbus.org/v1.3/reference/protocols/schema/</loc>
<lastmod>2023-08-17</lastmod>
<lastmod>2024-03-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://lightbus.org/v1.3/tutorial/</loc>
<lastmod>2023-08-17</lastmod>
<lastmod>2024-03-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://lightbus.org/v1.3/tutorial/django-and-lightbus/</loc>
<lastmod>2023-08-17</lastmod>
<lastmod>2024-03-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://lightbus.org/v1.3/tutorial/getting-involved/</loc>
<lastmod>2023-08-17</lastmod>
<lastmod>2024-03-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://lightbus.org/v1.3/tutorial/installation/</loc>
<lastmod>2023-08-17</lastmod>
<lastmod>2024-03-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://lightbus.org/v1.3/tutorial/quick-start/</loc>
<lastmod>2023-08-17</lastmod>
<lastmod>2024-03-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://lightbus.org/v1.3/tutorial/worked-example/</loc>
<lastmod>2023-08-17</lastmod>
<lastmod>2024-03-24</lastmod>
<changefreq>daily</changefreq>
</url>
</urlset>
Binary file modified v1.3/sitemap.xml.gz
View file
Binary file not shown.
6 changes: 3 additions & 3 deletions v1.3/tutorial/installation/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1405,8 +1405,8 @@ <h3 id="installing-using-git">Installing using git<a class="headerlink" href="#i
</code></pre></div>

<h2 id="13-installing-redis">1.3. Installing Redis<a class="headerlink" href="#13-installing-redis" title="Permanent link">&para;</a></h2>
<p>You will need Redis 5.0 or above in order to use Lightbus.</p>
<p>You can install Redis 5.0 on macOS by either:</p>
<p>You will need Redis (version 5 or above) in order to use Lightbus.</p>
<p>You can install Redis on macOS by either:</p>
<ol>
<li>Using <a href="https://brew.sh/">Homebrew</a> (<code>brew install redis</code>), or</li>
<li>Using docker (<code>docker run --rm -p 6379:6379 -d redis</code>) </li>
Expand All @@ -1418,7 +1418,7 @@ <h2 id="14-check-it-works">1.4. Check it works<a class="headerlink" href="#14-ch
<li>Lightbus installed</li>
<li>Redis installed and running</li>
</ol>
<p>You check check everything is setup correctly by starting up lightbus. First create a file
<p>You can check everything is setup correctly by starting up lightbus. First create a file
name <code>bus.py</code> which contains:</p>
<div class="highlight"><pre><span></span><code><span class="c1"># Create a bus.py file with the following contents</span>
<span class="kn">import</span> <span class="nn">lightbus</span>
Expand Down
2 changes: 1 addition & 1 deletion v1.3/tutorial/quick-start/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1326,7 +1326,7 @@ <h2 id="21-requirements">2.1 Requirements<a class="headerlink" href="#21-require
<ul>
<li>Installed Python 3.7 or above</li>
<li>Installed Lightbus</li>
<li>Running Redis 5 locally on the default port (6379)</li>
<li>Running Redis locally on the default port (6379)</li>
</ul>
<p>Optionally, you can read some additional <em>explanation</em> in the
<a href="../../explanation/anatomy-lesson/">anatomy lesson</a> section.</p>
Expand Down

0 comments on commit 6773d12

Please sign in to comment.