diff --git a/README.rst b/README.rst index 1d8a57ab..d647803d 100644 --- a/README.rst +++ b/README.rst @@ -61,8 +61,9 @@ Of particular use is the "How to write plugins" section. You can build the documentation yourself with:: - $ pip install sphinx - $ cd docs/ + $ pip install -r requirements.docs.txt + $ cd doc/ + $ ./regen_apidoc.sh $ make html Testing diff --git a/doc/api/csbot.plugins.rst b/doc/api/csbot.plugins.rst index 83f81df8..fa7783ba 100644 --- a/doc/api/csbot.plugins.rst +++ b/doc/api/csbot.plugins.rst @@ -5,6 +5,7 @@ Submodules ---------- .. toctree:: + :maxdepth: 4 csbot.plugins.auth csbot.plugins.calc diff --git a/doc/api/csbot.rst b/doc/api/csbot.rst index 3dde80fb..61a7b2b1 100644 --- a/doc/api/csbot.rst +++ b/doc/api/csbot.rst @@ -5,6 +5,7 @@ Subpackages ----------- .. toctree:: + :maxdepth: 4 csbot.plugins @@ -12,6 +13,7 @@ Submodules ---------- .. toctree:: + :maxdepth: 4 csbot.cli csbot.config diff --git a/src/csbot/plugins/github.py b/src/csbot/plugins/github.py index 56b8a71c..9fb1393a 100644 --- a/src/csbot/plugins/github.py +++ b/src/csbot/plugins/github.py @@ -103,7 +103,7 @@ Module contents =============== -""" +""" # noqa: E501 import hmac import datetime import json diff --git a/src/csbot/plugins/webhook.py b/src/csbot/plugins/webhook.py index fa76d358..55c1766b 100644 --- a/src/csbot/plugins/webhook.py +++ b/src/csbot/plugins/webhook.py @@ -16,7 +16,7 @@ async def webhook(self, e): Configuration ============= -The following configuration options are supported in the ``[webserver]`` config section: +The following configuration options are supported in the ``[webhook]`` config section: ================== =========== Setting Description