Repair docs (html, md). Update docstrings

SRV/models/network.py

@@ -3,14 +3,14 @@ from pydantic import BaseModel
 
 
 class IPv4Route(BaseModel):
-    """
-    Модель маршрута IPv4
+    """Модель маршрута IPv4.
 
     Атрибуты:
-        destination (str): IP-адрес назначения
-        prefix (int): Префикс подсети в формате CIDR
-        next_hop (str): Адрес следующего узла (маршрутизатор)
-        metric (int): Метрика маршрута
+
+    - ``destination`` (str): IP-адрес назначения.
+    - ``prefix`` (int): Префикс подсети в формате CIDR.
+    - ``next_hop`` (str): Адрес следующего узла (маршрутизатор).
+    - ``metric`` (int): Метрика маршрута.
     """
 
     destination: str
@@ -20,14 +20,14 @@ class IPv4Route(BaseModel):
 
 
 class IPv6Route(BaseModel):
-    """
-    Модель маршрута IPv6
+    """Модель маршрута IPv6.
 
     Атрибуты:
-        destination (str): IP-адрес назначения
-        prefix (int): Префикс подсети (CIDR)
-        next_hop (str): Адрес следующего узла (маршрутизатор)
-        metric (int): Метрика маршрута
+
+    - ``destination`` (str): IP-адрес назначения.
+    - ``prefix`` (int): Префикс подсети в формате CIDR.
+    - ``next_hop`` (str): Адрес следующего узла.
+    - ``metric`` (int): Метрика маршрута.
     """
 
     destination: str
@@ -37,15 +37,15 @@ class IPv6Route(BaseModel):
 
 
 class IndividualIPConfig(BaseModel):
-    """
-    Модель индивидуальной конфигурации IP-адреса
+    """Модель индивидуальной конфигурации IP-адреса.
 
     Атрибуты:
-        address (str): IP-адрес интерфейса
-        routes (List[Union[IPv4Route, IPv6Route]]): Список маршрутов (IPv4/IPv6)
-        method (Optional[str]): Метод назначения IP
-        gateway (str): Основной шлюз по умолчанию
-        dns (List[str]): Список DNS-серверов
+
+    - ``address`` (str): IP-адрес интерфейса.
+    - ``routes`` (List[Union[IPv4Route, IPv6Route]]): Список маршрутов.
+    - ``method`` (Optional[str]): Метод назначения IP.
+    - ``gateway`` (str): Шлюз по умолчанию.
+    - ``dns`` (List[str]): Список DNS-серверов.
     """
 
     address: str
@@ -56,31 +56,31 @@ class IndividualIPConfig(BaseModel):
 
 
 class IPConfig(BaseModel):
-    """
-    Модель конфигурации IP (IPv4/IPv6)
+    """Групповая конфигурация IP-адресов.
 
     Атрибуты:
-        configurations (List[IndividualIPConfig]): Список индивидуальных IP-конфигураций
+
+    - ``configurations`` (List[IndividualIPConfig]): Индивидуальные IP-конфигурации.
     """
 
     configurations: List[IndividualIPConfig]
 
 
 class NetworkInterface(BaseModel):
-    """
-    Модель базового сетевого интерфейса
+    """Модель базового сетевого интерфейса.
 
     Атрибуты:
-        name (str): Название интерфейса
-        type (str): Тип интерфейса
-        mac_address (str): MAC-адрес устройства
-        device_state (str): Состояние устройства
-        active_connection (str): Название активного соединения
-        device_mtu (str): MTU устройства
-        ipv4 (IPConfig): Конфигурация IPv4
-        ipv6 (IPConfig): Конфигурация IPv6
-        container_x (int): Положение по X на холсте
-        container_y (int): Положение по Y на холсте
+
+    - ``name`` (str): Название интерфейса.
+    - ``type`` (str): Тип устройства.
+    - ``mac_address`` (str): MAC-адрес.
+    - ``device_state`` (str): Текущее состояние.
+    - ``active_connection`` (str): Название активного соединения.
+    - ``device_mtu`` (str): MTU устройства.
+    - ``ipv4`` (IPConfig): IPv4-конфигурация.
+    - ``ipv6`` (IPConfig): IPv6-конфигурация.
+    - ``container_x`` (int): Положение по оси X на холсте.
+    - ``container_y`` (int): Положение по оси Y на холсте.
     """
 
     name: str
@@ -96,16 +96,16 @@ class NetworkInterface(BaseModel):
 
 
 class WiFiDevice(NetworkInterface):
-    """
-    Модель Wi-Fi устройства (наследуется от NetworkInterface)
+    """Расширенная модель Wi-Fi устройства.
 
     Атрибуты:
-        ssid (Optional[str]): Название Wi-Fi сети
-        bssid (Optional[str]): MAC-адрес точки доступа
-        bitrate (Optional[int]): Скорость соединения
-        strength (Optional[int]): Уровень сигнала
-        frequency (Optional[float]): Частота
-        mode (Union[str, int]): Режим работы
+
+    - ``ssid`` (Optional[str]): Название Wi-Fi сети.
+    - ``bssid`` (Optional[str]): MAC-адрес точки доступа.
+    - ``bitrate`` (Optional[int]): Скорость соединения.
+    - ``strength`` (Optional[int]): Уровень сигнала.
+    - ``frequency`` (Optional[float]): Рабочая частота.
+    - ``mode`` (Union[str, int]): Режим работы.
     """
 
     ssid: Optional[str] = None
@@ -117,13 +117,13 @@ class WiFiDevice(NetworkInterface):
 
 
 class NetworkInterfacesContainer(BaseModel):
-    """
-    Контейнер для группы сетевых интерфейсов с координатами
+    """Контейнер для набора сетевых интерфейсов.
 
     Атрибуты:
-        interfaces (List[Union[NetworkInterface, WiFiDevice]]): Список интерфейсов
-        container_x (int): Положение по оси X
-        container_y (int): Положение по оси Y
+
+    - ``interfaces`` (List[Union[NetworkInterface, WiFiDevice]]): Список интерфейсов.
+    - ``container_x`` (int): Положение по оси X.
+    - ``container_y`` (int): Положение по оси Y.
     """
 
     interfaces: List[Union[NetworkInterface, WiFiDevice]]
@@ -132,15 +132,15 @@ class NetworkInterfacesContainer(BaseModel):
 
 
 class Activation(BaseModel):
-    """
-    Модель активированных интерфейсов
+    """Модель узла активных интерфейсов.
 
     Атрибуты:
-        id (int): Идентификатор ноды активированных интерфейсов
-        interfaces (List[Union[NetworkInterface, WiFiDevice]]): Активированные интерфейсы
-        container_x (int): Положение по X на холсте
-        container_y (int): Положение по Y на холсте
-        isOpen (bool): Флаг скрытия ноды на холсте
+
+    - ``id`` (int): Идентификатор ноды.
+    - ``interfaces`` (List[Union[NetworkInterface, WiFiDevice]]): Активные интерфейсы.
+    - ``container_x`` (int): Координата X на холсте.
+    - ``container_y`` (int): Координата Y на холсте.
+    - ``isOpen`` (bool): Флаг отображения узла на холсте.
     """
 
     id: int
@@ -151,15 +151,15 @@ class Activation(BaseModel):
 
 
 class Deactivation(BaseModel):
-    """
-    Модель отключенных интерфейсов
+    """Модель узла отключённых интерфейсов.
 
     Атрибуты:
-        id (int): Идентификатор ноды отключенных интерфейсов
-        interfaces (List[Union[NetworkInterface, WiFiDevice]]): Отключенные интерфейсы
-        container_x (int): Положение по X на холсте
-        container_y (int): Положение по Y на холсте
-        isOpen (bool): Флаг скрытия ноды на холсте
+
+    - ``id`` (int): Идентификатор ноды.
+    - ``interfaces`` (List[Union[NetworkInterface, WiFiDevice]]): Список отключённых интерфейсов.
+    - ``container_x`` (int): Координата X на холсте.
+    - ``container_y`` (int): Координата Y на холсте.
+    - ``isOpen`` (bool): Флаг отображения узла на холсте.
     """
 
     id: int