Skip to content

Commit 9f62225

Browse files
committed
Docs: Full API documentation
1 parent 59971e0 commit 9f62225

3 files changed

Lines changed: 31 additions & 3 deletions

File tree

docs/api.rst

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,37 @@ API
44
.. automodule:: rawsocketpy
55
:members:
66

7-
.. automodule:: rawsocketpy.main
7+
.. automodule:: rawsocketpy.packet
88
:members:
9+
:special-members: __init__
10+
:undoc-members:
11+
:inherited-members:
12+
:show-inheritance:
913

14+
.. automodule:: rawsocketpy.socket
15+
:members:
16+
:special-members: __init__
17+
:undoc-members:
18+
:inherited-members:
19+
:show-inheritance:
1020

21+
.. automodule:: rawsocketpy.server
22+
:members:
23+
:special-members: __init__
24+
:undoc-members:
25+
:inherited-members:
26+
:show-inheritance:
1127

28+
.. automodule:: rawsocketpy.asyncserver
29+
:members:
30+
:special-members: __init__
31+
:undoc-members:
32+
:inherited-members:
33+
:show-inheritance:
1234

35+
.. automodule:: rawsocketpy.util
36+
:members:
37+
:special-members: __init__
38+
:undoc-members:
39+
:inherited-members:
40+
:show-inheritance:

docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@
9797
'display_version': True,
9898
'prev_next_buttons_location': 'bottom',
9999
'style_external_links': False,
100-
'vcs_pageview_mode': '',
100+
'vcs_pageview_mode': 'display_github',
101101
# Toc options
102102
'collapse_navigation': True,
103103
'sticky_navigation': True,

docs/server_mode.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
Asynchronous Server with custom data handler
2-
==================
2+
===============================================
33

44
To a raw server, you have the following options:
55

0 commit comments

Comments
 (0)