Merge pull request #2257 from Exirel/docs-reorganize-packages

docs: split files into subfolders
sopel-irc · May 13, 2022 · cea42e1 · cea42e1
2 parents d7dc478 + 42a7d7c
commit cea42e1
Show file tree

Hide file tree

Showing 41 changed files with 269 additions and 250 deletions.
diff --git a/docs/source/api.rst b/docs/source/api.rst
diff --git a/docs/source/config.rst b/docs/source/config.rst
diff --git a/docs/source/irc.rst b/docs/source/irc.rst
diff --git a/docs/source/package.rst b/docs/source/package.rst
@@ -5,10 +5,13 @@ Sopel Package API
 .. toctree::
     :titlesonly:
 
-    bot
-    trigger
-    config
-    db
-    api
-    irc
-    lifecycle
+    package/bot
+    package/trigger
+    package/config
+    package/db
+    package/tools
+    package/formatting
+    package/logger
+    package/irc
+    package/plugins
+    package/lifecycle
diff --git a/docs/source/bot.rst → docs/source/package/bot.rst b/docs/source/bot.rst → docs/source/package/bot.rst
@@ -2,10 +2,7 @@
 The bot and its state
 =====================
 
-.. autoclass:: sopel.bot.Sopel
+.. automodule:: sopel.bot
    :members:
    :inherited-members:
    :show-inheritance:
-
-.. autoclass:: sopel.bot.SopelWrapper
-   :members:
diff --git a/docs/source/package/config.rst b/docs/source/package/config.rst
@@ -0,0 +1,15 @@
+===========================
+Configuration functionality
+===========================
+
+.. toctree::
+
+   config/types
+   config/core_section
+
+sopel.config
+============
+
+.. automodule:: sopel.config
+   :members:
+   :undoc-members:
diff --git a/docs/source/package/config/core_section.rst b/docs/source/package/config/core_section.rst
@@ -0,0 +1,7 @@
+============
+Core Section
+============
+
+.. automodule:: sopel.config.core_section
+   :members:
+   :undoc-members:
diff --git a/docs/source/package/config/types.rst b/docs/source/package/config/types.rst
@@ -0,0 +1,7 @@
+============
+Option Types
+============
+
+.. automodule:: sopel.config.types
+   :members:
+   :undoc-members:
diff --git a/docs/source/db.rst → docs/source/package/db.rst b/docs/source/db.rst → docs/source/package/db.rst
diff --git a/docs/source/package/formatting.rst b/docs/source/package/formatting.rst
@@ -0,0 +1,7 @@
+==========
+Formatting
+==========
+
+.. automodule:: sopel.formatting
+   :members:
+   :undoc-members:
diff --git a/docs/source/package/irc.rst b/docs/source/package/irc.rst
@@ -0,0 +1,20 @@
+=======================
+IRC Core Implementation
+=======================
+
+.. toctree::
+
+    irc/backends
+    irc/modes
+    irc/isupport
+    irc/utils
+
+.. automodule:: sopel.irc
+    :members:
+    :undoc-members:
+    :inherited-members:
+    :show-inheritance:
+
+    .. autoclass:: AbstractBot
+        :members:
+        :undoc-members:
diff --git a/docs/source/package/irc/backends.rst b/docs/source/package/irc/backends.rst
@@ -0,0 +1,17 @@
+============
+IRC Backends
+============
+
+sopel.irc.abstract_backends
+===========================
+
+.. automodule:: sopel.irc.abstract_backends
+    :members:
+
+
+sopel.irc.backends
+==================
+
+.. automodule:: sopel.irc.backends
+    :members:
+    :show-inheritance:
diff --git a/docs/source/package/irc/isupport.rst b/docs/source/package/irc/isupport.rst
@@ -0,0 +1,6 @@
+========
+ISUPPORT
+========
+
+.. automodule:: sopel.irc.isupport
+    :members:
diff --git a/docs/source/package/irc/modes.rst b/docs/source/package/irc/modes.rst
@@ -0,0 +1,6 @@
+=============
+Mode Messages
+=============
+
+.. automodule:: sopel.irc.modes
+    :members:
diff --git a/docs/source/package/irc/utils.rst b/docs/source/package/irc/utils.rst
@@ -0,0 +1,6 @@
+=======
+Utility
+=======
+
+.. automodule:: sopel.irc.utils
+    :members:
diff --git a/docs/source/lifecycle.rst → docs/source/package/lifecycle.rst b/docs/source/lifecycle.rst → docs/source/package/lifecycle.rst
diff --git a/docs/source/package/loader.rst b/docs/source/package/loader.rst
@@ -0,0 +1,6 @@
+=============
+Plugin Loader
+=============
+
+.. automodule:: sopel.loader
+   :members:
diff --git a/docs/source/package/logger.rst b/docs/source/package/logger.rst
@@ -0,0 +1,7 @@
+======
+Logger
+======
+
+.. automodule:: sopel.logger
+   :members:
+   :undoc-members:
diff --git a/docs/source/package/plugins.rst b/docs/source/package/plugins.rst
@@ -0,0 +1,18 @@
+=========================
+Plugin Internal Machinery
+=========================
+
+.. important::
+
+   This section contains modules and classes used by Sopel internally. They are
+   subject to rapid changes between versions, without advance warning. This
+   section exists primarily for the aid of Sopel’s core development.
+
+.. toctree::
+
+    loader
+    plugins/plugins
+    plugins/exceptions
+    plugins/handlers
+    plugins/jobs
+    plugins/rules
diff --git a/docs/source/package/plugins/exceptions.rst b/docs/source/package/plugins/exceptions.rst
@@ -0,0 +1,6 @@
+========================
+sopel.plugins.exceptions
+========================
+
+.. automodule:: sopel.plugins.exceptions
+   :members:
diff --git a/docs/source/package/plugins/handlers.rst b/docs/source/package/plugins/handlers.rst
@@ -0,0 +1,6 @@
+======================
+sopel.plugins.handlers
+======================
+
+.. automodule:: sopel.plugins.handlers
+   :members:
diff --git a/docs/source/package/plugins/jobs.rst b/docs/source/package/plugins/jobs.rst
@@ -0,0 +1,7 @@
+==================
+sopel.plugins.jobs
+==================
+
+.. automodule:: sopel.plugins.jobs
+   :members:
+   :show-inheritance:
diff --git a/docs/source/package/plugins/plugins.rst b/docs/source/package/plugins/plugins.rst
@@ -0,0 +1,6 @@
+=============
+sopel.plugins
+=============
+
+.. automodule:: sopel.plugins
+   :members: