Merge pull request #170 from alanbriolat/cleanup

Cleanup
HackSoc · Feb 19, 2022 · 645fbd5 · 645fbd5
2 parents 63ac305 + b6113b6
commit 645fbd5
Show file tree

Hide file tree

Showing 48 changed files with 787 additions and 921 deletions.
diff --git 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.cli.rst b/doc/api/csbot.cli.rst
@@ -0,0 +1,7 @@
+csbot.cli module
+================
+
+.. automodule:: csbot.cli
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/api/csbot.config.rst b/doc/api/csbot.config.rst
@@ -0,0 +1,7 @@
+csbot.config module
+===================
+
+.. automodule:: csbot.config
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/api/csbot.core.rst b/doc/api/csbot.core.rst
@@ -2,6 +2,6 @@ csbot.core module
 =================
 
 .. automodule:: csbot.core
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/api/csbot.events.rst b/doc/api/csbot.events.rst
@@ -2,6 +2,6 @@ csbot.events module
 ===================
 
 .. automodule:: csbot.events
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/api/csbot.irc.rst b/doc/api/csbot.irc.rst
@@ -2,6 +2,6 @@ csbot.irc module
 ================
 
 .. automodule:: csbot.irc
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/api/csbot.plugin.rst b/doc/api/csbot.plugin.rst
@@ -2,6 +2,6 @@ csbot.plugin module
 ===================
 
 .. automodule:: csbot.plugin
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/api/csbot.plugins.auth.rst b/doc/api/csbot.plugins.auth.rst
@@ -2,6 +2,6 @@ csbot.plugins.auth module
 =========================
 
 .. automodule:: csbot.plugins.auth
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/api/csbot.plugins.calc.rst b/doc/api/csbot.plugins.calc.rst
@@ -2,6 +2,6 @@ csbot.plugins.calc module
 =========================
 
 .. automodule:: csbot.plugins.calc
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/api/csbot.plugins.cron.rst b/doc/api/csbot.plugins.cron.rst
@@ -2,6 +2,6 @@ csbot.plugins.cron module
 =========================
 
 .. automodule:: csbot.plugins.cron
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/api/csbot.plugins.csyork.rst b/doc/api/csbot.plugins.csyork.rst
@@ -2,6 +2,6 @@ csbot.plugins.csyork module
 ===========================
 
 .. automodule:: csbot.plugins.csyork
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/api/csbot.plugins.github.rst b/doc/api/csbot.plugins.github.rst
@@ -2,6 +2,6 @@ csbot.plugins.github module
 ===========================
 
 .. automodule:: csbot.plugins.github
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/api/csbot.plugins.helix.rst b/doc/api/csbot.plugins.helix.rst
@@ -2,6 +2,6 @@ csbot.plugins.helix module
 ==========================
 
 .. automodule:: csbot.plugins.helix
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/api/csbot.plugins.hoogle.rst b/doc/api/csbot.plugins.hoogle.rst
@@ -2,6 +2,6 @@ csbot.plugins.hoogle module
 ===========================
 
 .. automodule:: csbot.plugins.hoogle
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/api/csbot.plugins.imgur.rst b/doc/api/csbot.plugins.imgur.rst
@@ -2,6 +2,6 @@ csbot.plugins.imgur module
 ==========================
 
 .. automodule:: csbot.plugins.imgur
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/api/csbot.plugins.last.rst b/doc/api/csbot.plugins.last.rst
@@ -2,6 +2,6 @@ csbot.plugins.last module
 =========================
 
 .. automodule:: csbot.plugins.last
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/api/csbot.plugins.linkinfo.rst b/doc/api/csbot.plugins.linkinfo.rst
@@ -2,6 +2,6 @@ csbot.plugins.linkinfo module
 =============================
 
 .. automodule:: csbot.plugins.linkinfo
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/api/csbot.plugins.logger.rst b/doc/api/csbot.plugins.logger.rst
@@ -2,6 +2,6 @@ csbot.plugins.logger module
 ===========================
 
 .. automodule:: csbot.plugins.logger
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/api/csbot.plugins.mongodb.rst b/doc/api/csbot.plugins.mongodb.rst
@@ -2,6 +2,6 @@ csbot.plugins.mongodb module
 ============================
 
 .. automodule:: csbot.plugins.mongodb
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git 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
@@ -31,6 +32,6 @@ Module contents
 ---------------
 
 .. automodule:: csbot.plugins
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/api/csbot.plugins.termdates.rst b/doc/api/csbot.plugins.termdates.rst
@@ -2,6 +2,6 @@ csbot.plugins.termdates module
 ==============================
 
 .. automodule:: csbot.plugins.termdates
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/api/csbot.plugins.topic.rst b/doc/api/csbot.plugins.topic.rst
@@ -2,6 +2,6 @@ csbot.plugins.topic module
 ==========================
 
 .. automodule:: csbot.plugins.topic
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/api/csbot.plugins.usertrack.rst b/doc/api/csbot.plugins.usertrack.rst
@@ -2,6 +2,6 @@ csbot.plugins.usertrack module
 ==============================
 
 .. automodule:: csbot.plugins.usertrack
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/api/csbot.plugins.webhook.rst b/doc/api/csbot.plugins.webhook.rst
@@ -2,6 +2,6 @@ csbot.plugins.webhook module
 ============================
 
 .. automodule:: csbot.plugins.webhook
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/api/csbot.plugins.webserver.rst b/doc/api/csbot.plugins.webserver.rst
@@ -2,6 +2,6 @@ csbot.plugins.webserver module
 ==============================
 
 .. automodule:: csbot.plugins.webserver
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/api/csbot.plugins.whois.rst b/doc/api/csbot.plugins.whois.rst
@@ -2,6 +2,6 @@ csbot.plugins.whois module
 ==========================
 
 .. automodule:: csbot.plugins.whois
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/api/csbot.plugins.xkcd.rst b/doc/api/csbot.plugins.xkcd.rst
@@ -2,6 +2,6 @@ csbot.plugins.xkcd module
 =========================
 
 .. automodule:: csbot.plugins.xkcd
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/api/csbot.plugins.youtube.rst b/doc/api/csbot.plugins.youtube.rst
@@ -2,6 +2,6 @@ csbot.plugins.youtube module
 ============================
 
 .. automodule:: csbot.plugins.youtube
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/api/csbot.rst b/doc/api/csbot.rst
@@ -5,14 +5,18 @@ Subpackages
 -----------
 
 .. toctree::
+   :maxdepth: 4
 
-    csbot.plugins
+   csbot.plugins
 
 Submodules
 ----------
 
 .. toctree::
+   :maxdepth: 4
 
+   csbot.cli
+   csbot.config
    csbot.core
    csbot.events
    csbot.irc
@@ -23,6 +27,6 @@ Module contents
 ---------------
 
 .. automodule:: csbot
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/api/csbot.util.rst b/doc/api/csbot.util.rst
@@ -2,6 +2,6 @@ csbot.util module
 =================
 
 .. automodule:: csbot.util
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/conf.py b/doc/conf.py
@@ -25,7 +25,14 @@
 
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.viewcode']
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.intersphinx',
+    'sphinx.ext.todo',
+    'sphinx.ext.coverage',
+    'sphinx.ext.viewcode',
+    'sphinx_rtd_theme',
+]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -91,7 +98,7 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'default'
+html_theme = 'sphinx_rtd_theme'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the

diff --git a/doc/regen_apidoc.sh b/doc/regen_apidoc.sh
@@ -1,3 +1,3 @@
 #!/bin/bash
 rm -rf api
-exec sphinx-apidoc --separate --output-dir=api/ ../csbot ../csbot/test ../csbot/test_broken ../csbot/plugins_broken
+exec sphinx-apidoc --separate --output-dir=api/ ../src/csbot ../src/plugins_broken
diff --git a/requirements.docs.txt b/requirements.docs.txt
@@ -0,0 +1,3 @@
+-r requirements.txt
+sphinx
+sphinx_rtd_theme
diff --git a/setup.py b/setup.py
@@ -15,22 +15,21 @@
     ],
     install_requires=[
         'click>=6.2,<7.0',
-        'straight.plugin==1.4.0-post-1',
         'pymongo>=4.0.1',
         'requests>=2.9.1,<3.0.0',
         'lxml>=2.3.5',
         'aiogoogle>=0.1.13',
         'isodate>=0.5.1',
         'aiohttp>=3.5.1,<4.0',
         'async_generator',
-        'attrs',
+        'attrs>=19.1,<20',
         'toml',
         'schematics',
         'rollbar',
     ],
     entry_points={
         'console_scripts': [
-            'csbot = csbot:main',
+            'csbot = csbot.cli:main',
             'csbot_util = csbot.cli:util',
         ],
     },