added mkdocs script

README.md

@@ -3,7 +3,7 @@ gitea: none
 include_toc: true
 ---
 
-# 🎴 Бот для ведения статистики клана в AniCard
+# 🎴 Клиент для ведения статистики клана в AniCard
 
 <img src="https://git.a2s.su/AniCard/ClanStat/raw/branch/master/assets/icon.png" alt="Иконка" height="512">
 
@@ -37,7 +37,7 @@ cp env.example .env
 - `DB_PASSWORD` — Пароль пользователя
 
 
-### 🐦‍🔥 Настройка виртуального окружения и загрузка бибилотек
+### 🐦‍🔥 Настройка виртуального окружения и загрузка библиотек
 
 Создание и активация виртуального окружения.
 

app/__init__.py

@@ -16,7 +16,7 @@ from .db import DataBase
 load_dotenv()  # Выполняет чтение .env
 
 client = Client(getenv('ACCOUNT'), api_id=getenv('APP_ID'), api_hash=getenv('APP_HASH'))
-"""Клиент Telegram"""
+"""🤖 Клиент Telegram"""
 
 db = DataBase(
     getenv('DB_HOST'),
@@ -25,7 +25,7 @@ db = DataBase(
     getenv('DB_USER'),
     getenv('DB_PASSWORD'),
 )
-"""База данных"""
+"""🗃️ База данных"""
 
 logger.add(getenv('LOG_PATH'), compression='zip')
 """Логгер"""
@@ -34,4 +34,4 @@ DELAY_TIME = 12 * 60 * 60  # 12 часов
 """Время приостановки выполнения цикла сбора статистики"""
 
 BOT_NAME = '@anicardplaybot'
-"""Имя бота"""
+"""🏷️ Имя бота"""

requirements-dev.txt

@@ -1 +1,2 @@
 black==24.10.0
+pdoc==15.0.1

scripts/mkdocs.sh

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+pdoc -o docs/ app