e-nms_qa_automation/site/config/mkdocs_guide/index.html

2365 lines
46 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link rel="prev" href="../../tools/fix_python_project/">
<link rel="next" href="../add_docstring/">
<link rel="icon" href="../../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.21">
<title>Документация проекта MkDocs - Документация тестов eNODE-Мониторинг</title>
<link rel="stylesheet" href="../../assets/stylesheets/main.66ac8b77.min.css">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
<link rel="stylesheet" href="../../assets/_mkdocstrings.css">
<script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
</head>
<body dir="ltr">
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#mkdocs-ui-alert_componentpy" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<header class="md-header md-header--shadow" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href="../.." title="Документация тестов eNODE-Мониторинг" class="md-header__button md-logo" aria-label="Документация тестов eNODE-Мониторинг" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
Документация тестов eNODE-Мониторинг
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Документация проекта MkDocs
</span>
</div>
</div>
</div>
<script>var media,input,key,value,palette=__md_get("__palette");if(palette&&palette.color){"(prefers-color-scheme)"===palette.color.media&&(media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']"),palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent"));for([key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
<label class="md-search__icon md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
</label>
<nav class="md-search__options" aria-label="Search">
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"/></svg>
</button>
</nav>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
</div>
<ol class="md-search-result__list" role="presentation"></ol>
</div>
</div>
</div>
</div>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href="../.." title="Документация тестов eNODE-Мониторинг" class="md-nav__button md-logo" aria-label="Документация тестов eNODE-Мониторинг" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>
</a>
Документация тестов eNODE-Мониторинг
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../.." class="md-nav__link">
<span class="md-ellipsis">
Главная
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" >
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
<span class="md-ellipsis">
Данные и конфигурации
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
Данные и конфигурации
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../data/constants/" class="md-nav__link">
<span class="md-ellipsis">
Constants
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../data/environment/" class="md-nav__link">
<span class="md-ellipsis">
Environment
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../data/roles_dict/" class="md-nav__link">
<span class="md-ellipsis">
Roles_dict
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" >
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
<span class="md-ellipsis">
Фикстуры Pytest
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
Фикстуры Pytest
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../fixtures/pages/" class="md-nav__link">
<span class="md-ellipsis">
Browser Fixtures
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
<span class="md-ellipsis">
Компоненты UI
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
Компоненты UI
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../components/alert_component/" class="md-nav__link">
<span class="md-ellipsis">
AlertComponent
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../components/base_component/" class="md-nav__link">
<span class="md-ellipsis">
BaseComponent
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../components/card_component/" class="md-nav__link">
<span class="md-ellipsis">
CardComponent
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../components/confirm_component/" class="md-nav__link">
<span class="md-ellipsis">
ConfirmComponent
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../components/json_container_component/" class="md-nav__link">
<span class="md-ellipsis">
JsonContainerComponent
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../components/modal_window_component/" class="md-nav__link">
<span class="md-ellipsis">
ModalWindowComponent
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../components/navbar_component/" class="md-nav__link">
<span class="md-ellipsis">
NavigationPanelComponent
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../components/table_component/" class="md-nav__link">
<span class="md-ellipsis">
TableComponent
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../components/toolbar_component/" class="md-nav__link">
<span class="md-ellipsis">
ToolbarComponent
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
<span class="md-ellipsis">
Элементы UI
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span>
Элементы UI
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../elements/base_element/" class="md-nav__link">
<span class="md-ellipsis">
BaseElement
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../elements/button_element/" class="md-nav__link">
<span class="md-ellipsis">
Button
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../elements/checkbox_element/" class="md-nav__link">
<span class="md-ellipsis">
Checkbox
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../elements/dropdown_list_element/" class="md-nav__link">
<span class="md-ellipsis">
DropdownList
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../elements/text_element/" class="md-nav__link">
<span class="md-ellipsis">
Text
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../elements/text_input_element/" class="md-nav__link">
<span class="md-ellipsis">
TextInput
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../elements/tooltip_button_element/" class="md-nav__link">
<span class="md-ellipsis">
ToolbarButton
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
<span class="md-ellipsis">
Локаторы
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6">
<span class="md-nav__icon md-icon"></span>
Локаторы
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../locators/button_locators/" class="md-nav__link">
<span class="md-ellipsis">
ButtonLocators
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../locators/confirm_locators/" class="md-nav__link">
<span class="md-ellipsis">
ConfirmLocators
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../locators/event_panel_locators/" class="md-nav__link">
<span class="md-ellipsis">
EventPanelLocators
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../locators/input_locators/" class="md-nav__link">
<span class="md-ellipsis">
InputLocators
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../locators/json_container_locators/" class="md-nav__link">
<span class="md-ellipsis">
JsonContainerLocators
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../locators/modal_window_locators/" class="md-nav__link">
<span class="md-ellipsis">
ModalWindowLocators
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../locators/navigation_panel_locators/" class="md-nav__link">
<span class="md-ellipsis">
NavigationPanelLocators
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../locators/table_locators/" class="md-nav__link">
<span class="md-ellipsis">
TableLocators
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../locators/text_locators/" class="md-nav__link">
<span class="md-ellipsis">
TextLocators
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../locators/toolbar_locators/" class="md-nav__link">
<span class="md-ellipsis">
ToolbarLocators
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" >
<label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
<span class="md-ellipsis">
Модальные окна
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_7">
<span class="md-nav__icon md-icon"></span>
Модальные окна
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../modal_windows/modal_add_user/" class="md-nav__link">
<span class="md-ellipsis">
AddUserModalWindow
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../modal_windows/modal_edit_user/" class="md-nav__link">
<span class="md-ellipsis">
EditUserModalWindow
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8" >
<label class="md-nav__link" for="__nav_8" id="__nav_8_label" tabindex="0">
<span class="md-ellipsis">
Страницы приложения
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_8">
<span class="md-nav__icon md-icon"></span>
Страницы приложения
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../pages/base_page/" class="md-nav__link">
<span class="md-ellipsis">
BasePage
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../pages/license_tab/" class="md-nav__link">
<span class="md-ellipsis">
LicenseTab
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../pages/login_page/" class="md-nav__link">
<span class="md-ellipsis">
LoginPage
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../pages/main_page/" class="md-nav__link">
<span class="md-ellipsis">
MainPage
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../pages/service_status_tab/" class="md-nav__link">
<span class="md-ellipsis">
ServiceStatusTab
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../pages/session_tab/" class="md-nav__link">
<span class="md-ellipsis">
SessionTab
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../pages/users_tab/" class="md-nav__link">
<span class="md-ellipsis">
UsersTab
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_9" >
<label class="md-nav__link" for="__nav_9" id="__nav_9_label" tabindex="0">
<span class="md-ellipsis">
Тесты
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_9_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_9">
<span class="md-nav__icon md-icon"></span>
Тесты
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_9_1" >
<label class="md-nav__link" for="__nav_9_1" id="__nav_9_1_label" tabindex="0">
<span class="md-ellipsis">
End-to-End
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_9_1_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_9_1">
<span class="md-nav__icon md-icon"></span>
End-to-End
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../tests/e2e/test_license_tab/" class="md-nav__link">
<span class="md-ellipsis">
TestLicenseTab
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../tests/e2e/test_login/" class="md-nav__link">
<span class="md-ellipsis">
TestLogin
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../tests/e2e/test_sessions_tab/" class="md-nav__link">
<span class="md-ellipsis">
TestSessionTab
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../tests/e2e/test_users_tab/" class="md-nav__link">
<span class="md-ellipsis">
TestUsersTab
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../tests/e2e/test_service_status_tab/" class="md-nav__link">
<span class="md-ellipsis">
TestServiceStatusTab
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../tests/e2e/test_expand_navigation_panel/" class="md-nav__link">
<span class="md-ellipsis">
TestNavigationPanel
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_9_2" >
<label class="md-nav__link" for="__nav_9_2" id="__nav_9_2_label" tabindex="0">
<span class="md-ellipsis">
Компоненты
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_9_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_9_2">
<span class="md-nav__icon md-icon"></span>
Компоненты
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../tests/components/test_json_container/" class="md-nav__link">
<span class="md-ellipsis">
TestJsonContainer
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../tests/components/test_navigation_panel/" class="md-nav__link">
<span class="md-ellipsis">
TestNavigationPanel
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../tests/components/test_services_table/" class="md-nav__link">
<span class="md-ellipsis">
TestServiceStatusTable
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../tests/components/test_user_modal_window/" class="md-nav__link">
<span class="md-ellipsis">
TestUsersModalWindow
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_10" >
<label class="md-nav__link" for="__nav_10" id="__nav_10_label" tabindex="0">
<span class="md-ellipsis">
Утилиты
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_10_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_10">
<span class="md-nav__icon md-icon"></span>
Утилиты
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../tools/logger/" class="md-nav__link">
<span class="md-ellipsis">
Logging
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../tools/fix_python_project/" class="md-nav__link">
<span class="md-ellipsis">
Python Project Fixer
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--active md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_11" checked>
<label class="md-nav__link" for="__nav_11" id="__nav_11_label" tabindex="0">
<span class="md-ellipsis">
Инструкции
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_11_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_11">
<span class="md-nav__icon md-icon"></span>
Инструкции
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis">
Документация проекта MkDocs
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
Документация проекта MkDocs
</span>
</a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#1" class="md-nav__link">
<span class="md-ellipsis">
1 Структура проекта
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#2-mkdocs" class="md-nav__link">
<span class="md-ellipsis">
2 Инструкция по настройке MkDocs
</span>
</a>
<nav class="md-nav" aria-label="2 Инструкция по настройке MkDocs">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#21" class="md-nav__link">
<span class="md-ellipsis">
2.1 Установка зависимостей
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#22" class="md-nav__link">
<span class="md-ellipsis">
2.2 Инициализация проекта
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#3" class="md-nav__link">
<span class="md-ellipsis">
3 Добавление документации
</span>
</a>
<nav class="md-nav" aria-label="3 Добавление документации">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#31-docstrings-alert-alert_componentpy" class="md-nav__link">
<span class="md-ellipsis">
3.1 Добавление комментариев docstrings в Компонент Alert (alert_component.py)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#32-mkdocs-mkdocsyml" class="md-nav__link">
<span class="md-ellipsis">
3.2 Конфигурация MkDocs (mkdocs.yml)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#33-alert" class="md-nav__link">
<span class="md-ellipsis">
3.3 Создание файла описания Компонента Alert
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#4" class="md-nav__link">
<span class="md-ellipsis">
4 Работа с документацией.
</span>
</a>
<nav class="md-nav" aria-label="4 Работа с документацией.">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#41" class="md-nav__link">
<span class="md-ellipsis">
4.1 Просмотр в реальном времени
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#42" class="md-nav__link">
<span class="md-ellipsis">
4.2 Сборка документации
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#5" class="md-nav__link">
<span class="md-ellipsis">
5 Частые проблемы и решения
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#6" class="md-nav__link">
<span class="md-ellipsis">
6 Заключение
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../add_docstring/" class="md-nav__link">
<span class="md-ellipsis">
Требования при добавлении docstring
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../code_development_process/" class="md-nav__link">
<span class="md-ellipsis">
Процесс разработки кода
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#1" class="md-nav__link">
<span class="md-ellipsis">
1 Структура проекта
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#2-mkdocs" class="md-nav__link">
<span class="md-ellipsis">
2 Инструкция по настройке MkDocs
</span>
</a>
<nav class="md-nav" aria-label="2 Инструкция по настройке MkDocs">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#21" class="md-nav__link">
<span class="md-ellipsis">
2.1 Установка зависимостей
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#22" class="md-nav__link">
<span class="md-ellipsis">
2.2 Инициализация проекта
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#3" class="md-nav__link">
<span class="md-ellipsis">
3 Добавление документации
</span>
</a>
<nav class="md-nav" aria-label="3 Добавление документации">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#31-docstrings-alert-alert_componentpy" class="md-nav__link">
<span class="md-ellipsis">
3.1 Добавление комментариев docstrings в Компонент Alert (alert_component.py)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#32-mkdocs-mkdocsyml" class="md-nav__link">
<span class="md-ellipsis">
3.2 Конфигурация MkDocs (mkdocs.yml)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#33-alert" class="md-nav__link">
<span class="md-ellipsis">
3.3 Создание файла описания Компонента Alert
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#4" class="md-nav__link">
<span class="md-ellipsis">
4 Работа с документацией.
</span>
</a>
<nav class="md-nav" aria-label="4 Работа с документацией.">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#41" class="md-nav__link">
<span class="md-ellipsis">
4.1 Просмотр в реальном времени
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#42" class="md-nav__link">
<span class="md-ellipsis">
4.2 Сборка документации
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#5" class="md-nav__link">
<span class="md-ellipsis">
5 Частые проблемы и решения
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#6" class="md-nav__link">
<span class="md-ellipsis">
6 Заключение
</span>
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<h1 id="mkdocs-ui-alert_componentpy">Документация проекта: настройка MkDocs и добавление документации Компонента UI "alert_component.py"</h1>
<h2 id="1">1 Структура проекта</h2>
<pre><code>nms_tests/
├── docs/
│ ├── components/
│ │ └── alert_component.md
│ └── index.md
├── components/
│ └── alert_component.py
└── mkdocs.yml
</code></pre>
<h2 id="2-mkdocs">2 Инструкция по настройке MkDocs</h2>
<h3 id="21">2.1 Установка зависимостей</h3>
<p>powershell
pip install mkdocs mkdocs-material mkdocstrings mkdocstrings-python</p>
<h3 id="22">2.2 Инициализация проекта</h3>
<p>powershell
mkdocs new .</p>
<h2 id="3">3 Добавление документации</h2>
<h3 id="31-docstrings-alert-alert_componentpy">3.1 Добавление комментариев docstrings в Компонент Alert (alert_component.py)</h3>
<pre><code>python
&quot;&quot;&quot;Модуль для работы с компонентом alert-окна в Playwright.
Содержит класс AlertComponent для взаимодействия с различными типами
alert-окон (error, success, info, warning) и проверки их состояния.
&quot;&quot;&quot;
from playwright.sync_api import Page, expect
from tools.logger import get_logger
from elements.text_element import Text
from components.base_component import BaseComponent
logger = get_logger(&quot;ALERT&quot;)
class AlertComponent(BaseComponent):
&quot;&quot;&quot;Компонент для работы с alert-окнами Playwright.
Поддерживает типы: error, success, info, warning.
Позволяет проверять наличие, отсутствие и текст сообщений.
&quot;&quot;&quot;
# ... (полный код класса из исходного файла)
</code></pre>
<h3 id="32-mkdocs-mkdocsyml">3.2 Конфигурация MkDocs (mkdocs.yml)</h3>
<pre><code>yaml
site_name: Документация тестов
theme:
name: material
plugins:
- search
- mkdocstrings:
default_handler: python
handlers:
python:
paths: [&quot;.&quot;, &quot;pages&quot;]
options:
show_source: true
nav:
- Главная: index.md
- Компоненты UI:
- AlertComponent: components/alert_component.md
# ... (остальная структура навигации)
</code></pre>
<h3 id="33-alert">3.3 Создание файла описания Компонента Alert</h3>
<p>docs/components/alert_component.md:</p>
<pre><code>markdown
# AlertComponent
::: components.alert_component:AlertComponent
handler: python
options:
show_source: true
heading_level: 2
</code></pre>
<h2 id="4">4 Работа с документацией.</h2>
<h3 id="41">4.1 Просмотр в реальном времени</h3>
<p>bash</p>
<p>mkdocs serve</p>
<h3 id="42">4.2 Сборка документации</h3>
<p>bash</p>
<p>rmdir /s /q site # Очистка кэша</p>
<p>mkdocs build # Пересборка</p>
<h2 id="5">5 Частые проблемы и решения</h2>
<p>Ошибки импорта:</p>
<ul>
<li>
<p>Убедитесь в наличии <strong>init</strong>.py в директориях.</p>
</li>
<li>
<p>Проверьте пути в mkdocs.yml.</p>
</li>
</ul>
<p>Предупреждения аннотации типов для параметра:</p>
<p>Убедитесь в наличии аннотации типов для параметра.</p>
<h2 id="6">6 Заключение</h2>
<p>Для обновления документации после изменений в коде:</p>
<ul>
<li>
<p>Внесите изменения в docstrings Python-кода.</p>
</li>
<li>
<p>Обновите соответствующие .md-файлы.</p>
</li>
<li>
<p>Пересоберите документацию.</p>
</li>
</ul>
</article>
</div>
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
</div>
</main>
<footer class="md-footer">
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-copyright">
Made with
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
Material for MkDocs
</a>
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"base": "../..", "features": [], "search": "../../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
<script src="../../assets/javascripts/bundle.a7c05c9e.min.js"></script>
</body>
</html>