Switch to Furo documentation template

docs/api.rst

@@ -2,90 +2,11 @@ API Reference
 =============
 
 .. toctree::
-   :maxdepth: 3
+   :maxdepth: 2
-
+
-.. module:: socketio
+   api_simpleclient
-
+   api_client
-.. autoclass:: SimpleClient
+   api_server
-   :members:
+   api_middleware
-   :inherited-members:
+   api_namespace
-
+   api_manager
-.. autoclass:: AsyncSimpleClient
-   :members:
-   :inherited-members:
-
-.. autoclass:: Client
-   :members:
-   :inherited-members:
-
-.. autoclass:: AsyncClient
-   :members:
-   :inherited-members:
-
-.. autoclass:: Server
-   :members:
-   :inherited-members:
-
-.. autoclass:: AsyncServer
-   :members:
-   :inherited-members:
-
-.. autoclass:: socketio.exceptions.ConnectionRefusedError
-   :members:
-
-.. autoclass:: WSGIApp
-   :members:
-
-.. autoclass:: ASGIApp
-   :members:
-
-.. autoclass:: Middleware
-   :members:
-
-.. autoclass:: ClientNamespace
-   :members:
-   :inherited-members:
-
-.. autoclass:: Namespace
-   :members:
-   :inherited-members:
-
-.. autoclass:: AsyncClientNamespace
-   :members:
-   :inherited-members:
-
-.. autoclass:: AsyncNamespace
-   :members:
-   :inherited-members:
-
-.. autoclass:: Manager
-   :members:
-   :inherited-members:
-
-.. autoclass:: PubSubManager
-   :members:
-   :inherited-members:
-
-.. autoclass:: KombuManager
-   :members:
-   :inherited-members:
-
-.. autoclass:: RedisManager
-   :members:
-   :inherited-members:
-
-.. autoclass:: KafkaManager
-   :members:
-   :inherited-members:
-
-.. autoclass:: AsyncManager
-   :members:
-   :inherited-members:
-
-.. autoclass:: AsyncRedisManager
-   :members:
-   :inherited-members:
-
-.. autoclass:: AsyncAioPikaManager
-   :members:
-   :inherited-members:

docs/api_client.rst

@@ -0,0 +1,11 @@
+Clients
+-------
+
+.. autoclass:: socketio.Client
+   :members:
+   :inherited-members:
+
+.. autoclass:: socketio.AsyncClient
+   :members:
+   :inherited-members:
+

docs/api_manager.rst

@@ -0,0 +1,39 @@
+Managers
+--------
+
+.. autoclass:: socketio.Manager
+   :members:
+   :inherited-members:
+
+.. autoclass:: socketio.PubSubManager
+   :members:
+   :inherited-members:
+
+.. autoclass:: socketio.KombuManager
+   :members:
+   :inherited-members:
+
+.. autoclass:: socketio.RedisManager
+   :members:
+   :inherited-members:
+
+.. autoclass:: socketio.KafkaManager
+   :members:
+   :inherited-members:
+
+.. autoclass:: socketio.ZmqManager
+   :members:
+   :inherited-members:
+
+.. autoclass:: socketio.AsyncManager
+   :members:
+   :inherited-members:
+
+.. autoclass:: socketio.AsyncRedisManager
+   :members:
+   :inherited-members:
+
+.. autoclass:: socketio.AsyncAioPikaManager
+   :members:
+   :inherited-members:
+

docs/api_middleware.rst

@@ -0,0 +1,12 @@
+Middlewares
+-----------
+
+.. autoclass:: socketio.WSGIApp
+   :members:
+
+.. autoclass:: socketio.ASGIApp
+   :members:
+
+.. autoclass:: socketio.Middleware
+   :members:
+

docs/api_namespace.rst

@@ -0,0 +1,19 @@
+Namespaces
+----------
+
+.. autoclass:: socketio.ClientNamespace
+   :members:
+   :inherited-members:
+
+.. autoclass:: socketio.Namespace
+   :members:
+   :inherited-members:
+
+.. autoclass:: socketio.AsyncClientNamespace
+   :members:
+   :inherited-members:
+
+.. autoclass:: socketio.AsyncNamespace
+   :members:
+   :inherited-members:
+

docs/api_server.rst

@@ -0,0 +1,14 @@
+Servers
+-------
+
+.. autoclass:: socketio.Server
+   :members:
+   :inherited-members:
+
+.. autoclass:: socketio.AsyncServer
+   :members:
+   :inherited-members:
+
+.. autoclass:: socketio.exceptions.ConnectionRefusedError
+   :members:
+

docs/api_simpleclient.rst

@@ -0,0 +1,11 @@
+Simple Clients
+--------------
+
+.. autoclass:: socketio.SimpleClient
+   :members:
+   :inherited-members:
+
+.. autoclass:: socketio.AsyncSimpleClient
+   :members:
+   :inherited-members:
+

docs/conf.py

@@ -77,20 +77,14 @@ pygments_style = None
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'alabaster'
+html_theme = 'furo'
+html_title = 'python-socketio'
 
 # 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
 # documentation.
 #
 html_theme_options = {
-    'github_user': 'miguelgrinberg',
-    'github_repo': 'python-socketio',
-    'github_banner': True,
-    'github_button': True,
-    'github_type': 'star',
-    'fixed_sidebar': True,
-
 }
 
 # Add any paths that contain custom static files (such as style sheets) here,

docs/index.rst

@@ -10,7 +10,7 @@ This projects implements Socket.IO clients and servers that can run standalone
 or integrated with a variety of Python web frameworks.
 
 .. toctree::
-   :maxdepth: 3
+   :maxdepth: 2
 
    intro
    client

pyproject.toml

@@ -39,6 +39,7 @@ dev = [
 ]
 docs = [
     "sphinx",
+    "furo",
 ]
 
 [tool.setuptools]

tox.ini

@@ -26,6 +26,7 @@ commands=
 changedir=docs
 deps=
     sphinx
+    furo
 allowlist_externals=
     make
 commands=