From a27c7e2eaf79079f3eb6fdf5de98e4e9e335f548 Mon Sep 17 00:00:00 2001 From: kaliko Date: Thu, 23 Mar 2023 21:12:43 +0100 Subject: [PATCH] Fixed documentation --- doc/source/doc.rst | 4 ++-- doc/source/index.rst | 2 +- doc/source/rtbl.rst | 6 ++++-- 3 files changed, 7 insertions(+), 5 deletions(-) diff --git a/doc/source/doc.rst b/doc/source/doc.rst index 0252040..10bc5e8 100644 --- a/doc/source/doc.rst +++ b/doc/source/doc.rst @@ -1,5 +1,5 @@ -Documentation -============== +Development documentation +========================= The Bot ------- diff --git a/doc/source/index.rst b/doc/source/index.rst index a74a8ac..f25adc5 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -10,8 +10,8 @@ :maxdepth: 2 :caption: Contents: - doc.rst rtbl.rst + doc.rst plugins.rst contribute.rst diff --git a/doc/source/rtbl.rst b/doc/source/rtbl.rst index daa891c..b8f34fc 100644 --- a/doc/source/rtbl.rst +++ b/doc/source/rtbl.rst @@ -7,7 +7,7 @@ The real time block list plugin can be used easily calling the module: # Create the virtual env python3 -m venv --prompt "rtbl-bot" venv - ./venv/bin/activate + . ./venv/bin/activate pip install -U pip wheel slixmpp==1.8.3 # Fetch the code git clone -b dev https://gitlab.com/kaliko/sid.git @@ -20,8 +20,10 @@ Then run, within the same virtual env: .. code:: bash # Activate the previously created virtual env - ./venv/bin/activate + . ./venv/bin/activate # Run the bot python3 -m sid.rtbl --jid botjid@example.org \ --room muc_to_moderate@conf.example.org \ --rtbl xmppbl.org + +.. vim: spell spelllang=en -- 2.39.2