Sphinx generate docs

This commit is contained in:
Merelden 2025-10-14 12:17:13 +05:00
parent 5bc23e7eb8
commit af1420dbde
216 changed files with 39471 additions and 13 deletions

View file

@ -0,0 +1,9 @@
Конфигурация
============
.. toctree::
:maxdepth: 1
config/cors
config/init_config
config/ports

View file

@ -0,0 +1,7 @@
config.cors
===========
.. automodule:: config.cors
:members:
:undoc-members:
:show-inheritance:

View file

@ -0,0 +1,7 @@
config.init_config
===================
.. automodule:: config.init_config
:members:
:undoc-members:
:show-inheritance:

View file

@ -0,0 +1,7 @@
config.ports
============
.. automodule:: config.ports
:members:
:undoc-members:
:show-inheritance:

View file

@ -0,0 +1,7 @@
Core
====
.. toctree::
:maxdepth: 1
core/cli_executor

View file

@ -0,0 +1,7 @@
core.cli_executor
==================
.. automodule:: core.cli_executor
:members:
:undoc-members:
:show-inheritance:

View file

@ -0,0 +1,13 @@
API эндпоинты
=============
.. toctree::
:maxdepth: 1
endpoints/auth
endpoints/ip
endpoints/network
endpoints/settings
endpoints/subnet
endpoints/ufw
endpoints/websocket

View file

@ -0,0 +1,7 @@
api.v1.auth
===========
.. automodule:: api.v1.auth
:members:
:undoc-members:
:show-inheritance:

View file

@ -0,0 +1,7 @@
api.v1.ip
=========
.. automodule:: api.v1.ip
:members:
:undoc-members:
:show-inheritance:

View file

@ -0,0 +1,7 @@
api.v1.network
==============
.. automodule:: api.v1.network
:members:
:undoc-members:
:show-inheritance:

View file

@ -0,0 +1,7 @@
api.v1.settings
================
.. automodule:: api.v1.settings
:members:
:undoc-members:
:show-inheritance:

View file

@ -0,0 +1,7 @@
api.v1.subnet
=============
.. automodule:: api.v1.subnet
:members:
:undoc-members:
:show-inheritance:

View file

@ -0,0 +1,7 @@
api.v1.ufw
==========
.. automodule:: api.v1.ufw
:members:
:undoc-members:
:show-inheritance:

View file

@ -0,0 +1,7 @@
api.v1.websocket
================
.. automodule:: api.v1.websocket
:members:
:undoc-members:
:show-inheritance:

View file

@ -0,0 +1,12 @@
Модели
======
.. toctree::
:maxdepth: 1
models/auth
models/network
models/request
models/subnet
models/ufw
models/wifi

View file

@ -0,0 +1,7 @@
models.auth
===========
.. automodule:: models.auth
:members:
:undoc-members:
:show-inheritance:

View file

@ -0,0 +1,7 @@
models.network
==============
.. automodule:: models.network
:members:
:undoc-members:
:show-inheritance:

View file

@ -0,0 +1,7 @@
models.request
==============
.. automodule:: models.request
:members:
:undoc-members:
:show-inheritance:

View file

@ -0,0 +1,7 @@
models.subnet
=============
.. automodule:: models.subnet
:members:
:undoc-members:
:show-inheritance:

View file

@ -0,0 +1,7 @@
models.ufw
==========
.. automodule:: models.ufw
:members:
:undoc-members:
:show-inheritance:

View file

@ -0,0 +1,7 @@
models.wifi
===========
.. automodule:: models.wifi
:members:
:undoc-members:
:show-inheritance:

View file

@ -0,0 +1,21 @@
Сервисы
=======
.. automodule:: services
:members:
:undoc-members:
:show-inheritance:
.. toctree::
:maxdepth: 1
services/arp_service
services/auth_service
services/connect_service
services/firewalld_service
services/ip_service
services/network_service
services/settings_service
services/subnet_service
services/ufw_service
services/wifi_service

View file

@ -0,0 +1,7 @@
ARP Service
===========
.. automodule:: services.arp_service
:members:
:undoc-members:
:show-inheritance:

View file

@ -0,0 +1,7 @@
Auth Service
============
.. automodule:: services.auth_service
:members:
:undoc-members:
:show-inheritance:

View file

@ -0,0 +1,7 @@
Connect Service
===============
.. automodule:: services.connect_service
:members:
:undoc-members:
:show-inheritance:

View file

@ -0,0 +1,7 @@
Firewalld Service
=================
.. automodule:: services.firewalld_service
:members:
:undoc-members:
:show-inheritance:

View file

@ -0,0 +1,7 @@
IP Service
==========
.. automodule:: services.ip_service
:members:
:undoc-members:
:show-inheritance:

View file

@ -0,0 +1,7 @@
Network Service
===============
.. automodule:: services.network_service
:members:
:undoc-members:
:show-inheritance:

View file

@ -0,0 +1,7 @@
Settings Service
================
.. automodule:: services.settings_service
:members:
:undoc-members:
:show-inheritance:

View file

@ -0,0 +1,7 @@
Subnet Service
==============
.. automodule:: services.subnet_service
:members:
:undoc-members:
:show-inheritance:

View file

@ -0,0 +1,7 @@
UFW Service
===========
.. automodule:: services.ufw_service
:members:
:undoc-members:
:show-inheritance:

View file

@ -0,0 +1,7 @@
Wifi Service
============
.. automodule:: services.wifi_service
:members:
:undoc-members:
:show-inheritance:

View file

@ -0,0 +1,8 @@
Хранилища
=========
.. toctree::
:maxdepth: 1
storage/json_storage
storage/session_storage

View file

@ -0,0 +1,7 @@
storage.json_storage
=====================
.. automodule:: storage.json_storage
:members:
:undoc-members:
:show-inheritance:

View file

@ -0,0 +1,7 @@
storage.session_storage
=======================
.. automodule:: storage.session_storage
:members:
:undoc-members:
:show-inheritance:

View file

@ -0,0 +1,7 @@
Утилиты
=======
.. toctree::
:maxdepth: 1
utils/i18n

View file

@ -0,0 +1,7 @@
utils.i18n
==========
.. automodule:: utils.i18n
:members:
:undoc-members:
:show-inheritance:

View file

@ -0,0 +1,19 @@
GONETS SRV Documentation
=========================
Добро пожаловать в документацию серверной части GONETS (SRV).
Содержание
---------
.. toctree::
:maxdepth: 2
:caption: Разделы
api/services
api/models
api/endpoints
api/config
api/core
api/storage
api/utils