Skip to content

Commit add47d8

Browse files
miguelgrinbergmiguelgrinberg
committed
Switch to Furo documentation template
1 parent 6229261 commit add47d8

11 files changed

Lines changed: 119 additions & 96 deletions

‎docs/api.rst‎

Lines changed: 8 additions & 87 deletions
Original file line numberDiff line numberDiff line change
@@ -2,90 +2,11 @@ API Reference
22
=============
33

44
.. toctree::
5-
:maxdepth: 3
6-
7-
.. module:: socketio
8-
9-
.. autoclass:: SimpleClient
10-
:members:
11-
:inherited-members:
12-
13-
.. autoclass:: AsyncSimpleClient
14-
:members:
15-
:inherited-members:
16-
17-
.. autoclass:: Client
18-
:members:
19-
:inherited-members:
20-
21-
.. autoclass:: AsyncClient
22-
:members:
23-
:inherited-members:
24-
25-
.. autoclass:: Server
26-
:members:
27-
:inherited-members:
28-
29-
.. autoclass:: AsyncServer
30-
:members:
31-
:inherited-members:
32-
33-
.. autoclass:: socketio.exceptions.ConnectionRefusedError
34-
:members:
35-
36-
.. autoclass:: WSGIApp
37-
:members:
38-
39-
.. autoclass:: ASGIApp
40-
:members:
41-
42-
.. autoclass:: Middleware
43-
:members:
44-
45-
.. autoclass:: ClientNamespace
46-
:members:
47-
:inherited-members:
48-
49-
.. autoclass:: Namespace
50-
:members:
51-
:inherited-members:
52-
53-
.. autoclass:: AsyncClientNamespace
54-
:members:
55-
:inherited-members:
56-
57-
.. autoclass:: AsyncNamespace
58-
:members:
59-
:inherited-members:
60-
61-
.. autoclass:: Manager
62-
:members:
63-
:inherited-members:
64-
65-
.. autoclass:: PubSubManager
66-
:members:
67-
:inherited-members:
68-
69-
.. autoclass:: KombuManager
70-
:members:
71-
:inherited-members:
72-
73-
.. autoclass:: RedisManager
74-
:members:
75-
:inherited-members:
76-
77-
.. autoclass:: KafkaManager
78-
:members:
79-
:inherited-members:
80-
81-
.. autoclass:: AsyncManager
82-
:members:
83-
:inherited-members:
84-
85-
.. autoclass:: AsyncRedisManager
86-
:members:
87-
:inherited-members:
88-
89-
.. autoclass:: AsyncAioPikaManager
90-
:members:
91-
:inherited-members:
5+
:maxdepth: 2
6+
7+
api_simpleclient
8+
api_client
9+
api_server
10+
api_middleware
11+
api_namespace
12+
api_manager

‎docs/api_client.rst‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
Clients
2+
-------
3+
4+
.. autoclass:: socketio.Client
5+
:members:
6+
:inherited-members:
7+
8+
.. autoclass:: socketio.AsyncClient
9+
:members:
10+
:inherited-members:
11+

‎docs/api_manager.rst‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
Managers
2+
--------
3+
4+
.. autoclass:: socketio.Manager
5+
:members:
6+
:inherited-members:
7+
8+
.. autoclass:: socketio.PubSubManager
9+
:members:
10+
:inherited-members:
11+
12+
.. autoclass:: socketio.KombuManager
13+
:members:
14+
:inherited-members:
15+
16+
.. autoclass:: socketio.RedisManager
17+
:members:
18+
:inherited-members:
19+
20+
.. autoclass:: socketio.KafkaManager
21+
:members:
22+
:inherited-members:
23+
24+
.. autoclass:: socketio.ZmqManager
25+
:members:
26+
:inherited-members:
27+
28+
.. autoclass:: socketio.AsyncManager
29+
:members:
30+
:inherited-members:
31+
32+
.. autoclass:: socketio.AsyncRedisManager
33+
:members:
34+
:inherited-members:
35+
36+
.. autoclass:: socketio.AsyncAioPikaManager
37+
:members:
38+
:inherited-members:
39+

‎docs/api_middleware.rst‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
Middlewares
2+
-----------
3+
4+
.. autoclass:: socketio.WSGIApp
5+
:members:
6+
7+
.. autoclass:: socketio.ASGIApp
8+
:members:
9+
10+
.. autoclass:: socketio.Middleware
11+
:members:
12+

‎docs/api_namespace.rst‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
Namespaces
2+
----------
3+
4+
.. autoclass:: socketio.ClientNamespace
5+
:members:
6+
:inherited-members:
7+
8+
.. autoclass:: socketio.Namespace
9+
:members:
10+
:inherited-members:
11+
12+
.. autoclass:: socketio.AsyncClientNamespace
13+
:members:
14+
:inherited-members:
15+
16+
.. autoclass:: socketio.AsyncNamespace
17+
:members:
18+
:inherited-members:
19+

‎docs/api_server.rst‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
Servers
2+
-------
3+
4+
.. autoclass:: socketio.Server
5+
:members:
6+
:inherited-members:
7+
8+
.. autoclass:: socketio.AsyncServer
9+
:members:
10+
:inherited-members:
11+
12+
.. autoclass:: socketio.exceptions.ConnectionRefusedError
13+
:members:
14+

‎docs/api_simpleclient.rst‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
Simple Clients
2+
--------------
3+
4+
.. autoclass:: socketio.SimpleClient
5+
:members:
6+
:inherited-members:
7+
8+
.. autoclass:: socketio.AsyncSimpleClient
9+
:members:
10+
:inherited-members:
11+

‎docs/conf.py‎

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -77,20 +77,14 @@
7777
# The theme to use for HTML and HTML Help pages. See the documentation for
7878
# a list of builtin themes.
7979
#
80-
html_theme = 'alabaster'
80+
html_theme = 'furo'
81+
html_title = 'python-socketio'
8182

8283
# Theme options are theme-specific and customize the look and feel of a theme
8384
# further. For a list of options available for each theme, see the
8485
# documentation.
8586
#
8687
html_theme_options = {
87-
'github_user': 'miguelgrinberg',
88-
'github_repo': 'python-socketio',
89-
'github_banner': True,
90-
'github_button': True,
91-
'github_type': 'star',
92-
'fixed_sidebar': True,
93-
9488
}
9589

9690
# Add any paths that contain custom static files (such as style sheets) here,

‎docs/index.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ This projects implements Socket.IO clients and servers that can run standalone
1010
or integrated with a variety of Python web frameworks.
1111

1212
.. toctree::
13-
:maxdepth: 3
13+
:maxdepth: 2
1414

1515
intro
1616
client

‎pyproject.toml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ dev = [
3939
]
4040
docs = [
4141
"sphinx",
42+
"furo",
4243
]
4344

4445
[tool.setuptools]

0 commit comments

Comments
 (0)