builder-tools: fixed links for github

This commit is contained in:
Artem30801
2020-10-15 15:45:05 +03:00
parent 88b25b720a
commit a4db9e2528
3 changed files with 42 additions and 42 deletions

View File

@@ -96,7 +96,7 @@ class DocsGenerator:
relpath = os.path.sep.join(
os.path.relpath(module.__file__, output_path).split(os.path.sep)[1:]
)
docs = self.get_full_markdown(module, relpath)
docs = self.get_full_markdown(module, relpath.replace(os.path.sep, "/"))
with open(output_path, 'w') as f:
for line in docs:
f.write(line.replace("\n", os.linesep) + '\n')

View File

@@ -1,6 +1,6 @@
# Module [drone.modules.client_core](..\..\..\drone\modules\client_core.py)
# Module [drone.modules.client_core](../../../drone/modules/client_core.py)
## Module functions
## Class [Client](..\..\..\drone\modules\client_core.py#L25)
## Class [Client](../../../drone/modules/client_core.py#L25)
Client base class provides config loading, communication with server (including automatic reconnection, broadcast listening and binding).
@@ -9,17 +9,17 @@ Attributes:
server_connection (ConnectionManager) - connection to the server.
connected (bool) - whether the client is connected to the server.
connected (bool) - whether the client is connected to the server.
client_id (string) - ID of the client.
config (ConfigManager) - contains loaded client configuration.
config_path (string) - path to configuration file. There also should be config specification file at 'config_path\config\configspec_client.ini'.
### [\_\_init\_\_](../../../drone/modules/client_core.py#L37)
```py
def __init__(self, config_path='C:\\Users\\artem\\Documents\\GitHub\\COEX-clever-swarm\\clever-show\\drone\\modules\\..\\config\\client.ini')
```
```
Initialize self. See help(type(self)) for accurate signature.
### [broadcast\_bind](../../../drone/modules/client_core.py#L160)
```py
@@ -31,24 +31,24 @@ Args:
def get_ntp_time(ntp_host, ntp_port)
```
Gets and returns time from specified host and port of NTP server.
Args:
ntp_host (string): hostname or address of the NTP server.
ntp_host (string): hostname or address of the NTP server.
ntp_port (int): port of the NTP server.
Returns:
Returns:
int: Current time recieved from the NTP server
### [load\_config](../../../drone/modules/client_core.py#L53)
```py
def load_config(self)
```
```
Loads or reloads config from file specified in 'config_path'.
### [on\_broadcast\_bind](../../../drone/modules/client_core.py#L197)
```py

View File

@@ -1,6 +1,6 @@
# Module [lib.messaging](..\..\..\lib\messaging.py)
# Module [lib.messaging](../../../lib/messaging.py)
## Module functions
### [get\_ip\_address](..\..\..\lib\messaging.py#L39)
### [get\_ip\_address](../../../lib/messaging.py#L39)
```py
def get_ip_address()
```
@@ -8,7 +8,7 @@ Returns the IP address of current computer or `localhost` if no network connecti
Returns:
Returns:
string: IP address of current computer or `localhost` if no network connection present
### [message\_callback](../../../lib/messaging.py#L232)
@@ -16,12 +16,12 @@ Callback decorator. Functions registered by this decorator will be called upon r
def message_callback(action_string)
```
Callback decorator. Functions registered by this decorator will be called upon receiving action message.
Args:
action_string ([type]): [description]
action_string ([type]): [description]
### [request\_callback](../../../lib/messaging.py#L250)
```py
def request_callback(string_command)
@@ -35,77 +35,77 @@ Args:
Args:
Args:
sock (socket): socket
sock (socket): socket
after_idle_sec (int, optional): Start sending keepalive packets after this amount of seconds. Defaults to 1.
interval_sec (int, optional): Interval of keepalive packets in seconds. Defaults to 3.
max_fails (int, optional): Count of fails leading to socket disconnect. Defaults to 5.
Raises:
Raises:
NotImplementedError: for unknown platform
## Class [ConnectionManager](../../../lib/messaging.py#L263)
...
### [\_\_init\_\_](..\..\..\lib\messaging.py#L267)
### [\_\_init\_\_](../../../lib/messaging.py#L267)
```py
def __init__(self, whoami='computer')
```
Initialize self. See help(type(self)) for accurate signature.
### [close](..\..\..\lib\messaging.py#L324)
### [close](../../../lib/messaging.py#L324)
```py
def close(self)
```
### [connect](..\..\..\lib\messaging.py#L306)
### [connect](../../../lib/messaging.py#L306)
```py
def connect(self, client_selector, client_socket, client_addr)
```
### [get\_file](..\..\..\lib\messaging.py#L566)
### [get\_file](../../../lib/messaging.py#L566)
```py
def get_file(self, client_filepath, filepath=None, callback=None, callback_args=(), callback_kwargs=None)
```
### [get\_response](..\..\..\lib\messaging.py#L543)
### [get\_response](../../../lib/messaging.py#L543)
```py
def get_response(self, requested_value, callback, request_args=(), request_kwargs=None, callback_args=(), callback_kwargs=None)
```
### [process\_events](..\..\..\lib\messaging.py#L360)
### [process\_events](../../../lib/messaging.py#L360)
```py
def process_events(self, mask)
```
### [process\_received](..\..\..\lib\messaging.py#L408)
### [process\_received](../../../lib/messaging.py#L408)
```py
def process_received(self, message)
```
### [read](..\..\..\lib\messaging.py#L372)
### [read](../../../lib/messaging.py#L372)
```py
def read(self)
```
### [send\_file](../../../lib/messaging.py#L595)
```py
def send_file(self, filepath, dest_filepath)
def send_file(self, filepath, dest_filepath)
```
### [send\_message](../../../lib/messaging.py#L589)
```py
def send_message(self, action, args=(), kwargs=None)
```
```
### [write](../../../lib/messaging.py#L509)
```py
def write(self)
```
```
@@ -113,59 +113,59 @@ def process_message(self)
## Class [MessageManager](../../../lib/messaging.py#L105)
MessageManager class represents single incoming by TCP stream message and contains methods to decode and extract data from incoming data. It also contains static class methods for encoding various types of messages.
Attributes:
Attributes:
income_raw (bytes string) - Append incoming data to this attribute.
content: Would be populated when receiving and processing of the message will be completed. Deafults to None.
### [\_\_init\_\_](../../../lib/messaging.py#L112)
```py
def __init__(self)
def __init__(self)
```
Initialize self. See help(type(self)) for accurate signature.
Initialize self. See help(type(self)) for accurate signature.
### [process\_message](../../../lib/messaging.py#L217)
```py
def process_message(self)
```
[summary]
[summary]
## Class [Namespace](../../../lib/messaging.py#L22)
...
### [\_\_init\_\_](../../../lib/messaging.py#L23)
```py
def __init__(self, **kwargs)
def __init__(self, **kwargs)
```
Initialize self. See help(type(self)) for accurate signature.
## Class [NotifierSock](../../../lib/messaging.py#L607)
...
### [\_\_init\_\_](../../../lib/messaging.py#L608)
```py
def __init__(self)
def __init__(self)
```
Initialize self. See help(type(self)) for accurate signature.
### [close](../../../lib/messaging.py#L651)
```py
def close(self)
```
### [get\_sock](../../../lib/messaging.py#L631)
```py
```py
def get_sock(self)
```
### [init](../../../lib/messaging.py#L619)
```py
def init(self, selector, port=26000)
```
```
### [notify](../../../lib/messaging.py#L634)
```py