diff --git a/docs/api.rst b/docs/api.rst index 5a89bf6..fa26887 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -2,90 +2,11 @@ API Reference ============= .. toctree:: - :maxdepth: 3 - -.. module:: socketio - -.. autoclass:: SimpleClient - :members: - :inherited-members: - -.. 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: + :maxdepth: 2 + + api_simpleclient + api_client + api_server + api_middleware + api_namespace + api_manager diff --git a/docs/api_client.rst b/docs/api_client.rst new file mode 100644 index 0000000..f25602b --- /dev/null +++ b/docs/api_client.rst @@ -0,0 +1,11 @@ +Clients +------- + +.. autoclass:: socketio.Client + :members: + :inherited-members: + +.. autoclass:: socketio.AsyncClient + :members: + :inherited-members: + diff --git a/docs/api_manager.rst b/docs/api_manager.rst new file mode 100644 index 0000000..a706135 --- /dev/null +++ b/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: + diff --git a/docs/api_middleware.rst b/docs/api_middleware.rst new file mode 100644 index 0000000..dbb8cef --- /dev/null +++ b/docs/api_middleware.rst @@ -0,0 +1,12 @@ +Middlewares +----------- + +.. autoclass:: socketio.WSGIApp + :members: + +.. autoclass:: socketio.ASGIApp + :members: + +.. autoclass:: socketio.Middleware + :members: + diff --git a/docs/api_namespace.rst b/docs/api_namespace.rst new file mode 100644 index 0000000..63735be --- /dev/null +++ b/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: + diff --git a/docs/api_server.rst b/docs/api_server.rst new file mode 100644 index 0000000..452f17c --- /dev/null +++ b/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: + diff --git a/docs/api_simpleclient.rst b/docs/api_simpleclient.rst new file mode 100644 index 0000000..cf6fc82 --- /dev/null +++ b/docs/api_simpleclient.rst @@ -0,0 +1,11 @@ +Simple Clients +-------------- + +.. autoclass:: socketio.SimpleClient + :members: + :inherited-members: + +.. autoclass:: socketio.AsyncSimpleClient + :members: + :inherited-members: + diff --git a/docs/conf.py b/docs/conf.py index b5d242b..af658fa 100644 --- a/docs/conf.py +++ b/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, diff --git a/docs/index.rst b/docs/index.rst index a475d57..e247f4d 100644 --- a/docs/index.rst +++ b/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 diff --git a/pyproject.toml b/pyproject.toml index e186176..5414215 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -39,6 +39,7 @@ dev = [ ] docs = [ "sphinx", + "furo", ] [tool.setuptools] diff --git a/tox.ini b/tox.ini index b7e8e40..471510e 100644 --- a/tox.ini +++ b/tox.ini @@ -26,6 +26,7 @@ commands= changedir=docs deps= sphinx + furo allowlist_externals= make commands=