Skip to content

Commit cf92ab2

Browse files
docs: restructuring docs and rewording some stuff (nextcord#10)
Co-authored-by: Jonah Lawrence <[email protected]>
1 parent db80db2 commit cf92ab2

File tree

7 files changed

+247
-242
lines changed

7 files changed

+247
-242
lines changed

docs/conf.py

+7-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,13 @@
11
import re
2+
import sys
3+
import os
4+
25

36
project = "nextcord-ext-ipc"
4-
copyright = "2021, Nextcord Developers"
5-
author = "Nextcord Developers"
7+
copyright = "2021, nextcord"
8+
author = "nextcord"
9+
10+
sys.path.insert(0, os.path.abspath(".."))
611

712
_version_regex = r"^version = ('|\")((?:[0-9]+\.)*[0-9]+(?:\.?([a-z]+)(?:\.?[0-9])?)?)\1$"
813

Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
1-
Client Connection
2-
=================
3-
4-
The IPC client is very simple.
5-
It will simply connect to your server process and send JSON data.
6-
If you do not supply a port on initialisation, the client will connect to the multicast server
7-
(see the server section) and return the port from said server.
8-
If you do supply a port, it will connect to the server instantly.
9-
10-
Requests are made by calling ``ipc.client.request(endpoint, **kwargs)``
11-
and will be sent to the server in the json format specified above.
12-
It will then wait for a response and return the data.
13-
14-
.. currentmodule:: nextcord.ext.ipc.client
15-
16-
.. autoclass:: Client
17-
:members:
1+
Client Connection
2+
=================
3+
4+
The IPC client is very simple.
5+
It will simply connect to your server process and send JSON data.
6+
If you do not supply a port on initialisation, the client will connect to the multicast :doc:`server<server>` and return the port from said server.
7+
8+
If you do supply a port, it will connect to the server instantly.
9+
10+
Requests are made by calling :py:meth:`Client.request`
11+
and will be sent to the server in the json format specified above.
12+
It will then wait for a response and return the data.
13+
14+
.. currentmodule:: nextcord.ext.ipc.client
15+
16+
.. autoclass:: Client
17+
:members:
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
1-
IPC Errors
2-
==========
3-
4-
.. currentmodule:: nextcord.ext.ipc.errors
5-
6-
.. autoclass:: IPCError
7-
8-
.. autoclass:: NoEndpointFoundError
9-
10-
.. autoclass:: ServerConnectionRefusedError
11-
12-
.. autoclass:: JSONEncodeError
13-
14-
.. autoclass:: NotConnected
1+
IPC Errors
2+
==========
3+
4+
.. currentmodule:: nextcord.ext.ipc.errors
5+
6+
.. autoclass:: IPCError
7+
8+
.. autoclass:: NoEndpointFoundError
9+
10+
.. autoclass:: ServerConnectionRefusedError
11+
12+
.. autoclass:: JSONEncodeError
13+
14+
.. autoclass:: NotConnected

0 commit comments

Comments
 (0)