]> kaliko git repositories - sid.git/commitdiff
Fixed documentation
authorkaliko <kaliko@azylum.org>
Thu, 23 Mar 2023 20:12:43 +0000 (21:12 +0100)
committerkaliko <kaliko@azylum.org>
Thu, 23 Mar 2023 20:12:43 +0000 (21:12 +0100)
doc/source/doc.rst
doc/source/index.rst
doc/source/rtbl.rst

index 0252040e327bde68bcc53c59dbb6b0f64bddf51e..10bc5e8648bee68d512ef8a71dca5dfb78750116 100644 (file)
@@ -1,5 +1,5 @@
-Documentation
-==============
+Development documentation
+=========================
 
 The Bot
 -------
index a74a8acb958005fd8d12d8714e57bcfe4cbedda5..f25adc503d5c0f6c3eed84d5fc1cbabc9eb50b79 100644 (file)
@@ -10,8 +10,8 @@
    :maxdepth: 2
    :caption: Contents:
 
-   doc.rst
    rtbl.rst
+   doc.rst
    plugins.rst
    contribute.rst
 
index daa891c9fbd91eb6089f9eba021645642d04e53f..b8f34fcdc48cd3112744381eef253c5a128ed859 100644 (file)
@@ -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