822 lines
63 KiB
HTML
822 lines
63 KiB
HTML
|
||
|
||
<!DOCTYPE html>
|
||
<html class="writer-html5" lang="ru" data-content_root="./">
|
||
<head>
|
||
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||
<title>Руководство по документации тестов с помощью Sphinx — документация e-nms-qa-automation 0.1.0</title>
|
||
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
|
||
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
|
||
|
||
|
||
<script src="_static/jquery.js?v=5d32c60e"></script>
|
||
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
|
||
<script src="_static/documentation_options.js?v=6ff560e8"></script>
|
||
<script src="_static/doctools.js?v=9bcbadda"></script>
|
||
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
||
<script src="_static/translations.js?v=cd1d70c9"></script>
|
||
<script src="_static/js/theme.js"></script>
|
||
<link rel="index" title="Алфавитный указатель" href="genindex.html" />
|
||
<link rel="search" title="Поиск" href="search.html" />
|
||
<link rel="prev" title="tools package" href="tools.html" />
|
||
</head>
|
||
|
||
<body class="wy-body-for-nav">
|
||
<div class="wy-grid-for-nav">
|
||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||
<div class="wy-side-scroll">
|
||
<div class="wy-side-nav-search" >
|
||
|
||
|
||
|
||
<a href="index.html" class="icon icon-home">
|
||
e-nms-qa-automation
|
||
</a>
|
||
<div role="search">
|
||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||
<input type="text" name="q" placeholder="Поиск в документации" aria-label="Поиск в документации" />
|
||
<input type="hidden" name="check_keywords" value="yes" />
|
||
<input type="hidden" name="area" value="default" />
|
||
</form>
|
||
</div>
|
||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Меню навигации">
|
||
<p class="caption" role="heading"><span class="caption-text">Содержание:</span></p>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="modules.html">e-nms_qa_automation</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="components.html">components package</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="components.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="components.html#module-components.alert_component">components.alert_component module</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="components.html#components.alert_component.AlertComponent"><code class="docutils literal notranslate"><span class="pre">AlertComponent</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="components.html#module-components.base_component">components.base_component module</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="components.html#components.base_component.BaseComponent"><code class="docutils literal notranslate"><span class="pre">BaseComponent</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="components.html#module-components.card_component">components.card_component module</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="components.html#components.card_component.CardComponent"><code class="docutils literal notranslate"><span class="pre">CardComponent</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="components.html#module-components.confirm_component">components.confirm_component module</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="components.html#components.confirm_component.ConfirmComponent"><code class="docutils literal notranslate"><span class="pre">ConfirmComponent</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="components.html#module-components.date_picker_component">components.date_picker_component module</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="components.html#components.date_picker_component.DatePickerComponent"><code class="docutils literal notranslate"><span class="pre">DatePickerComponent</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="components.html#module-components.dropdown_list_component">components.dropdown_list_component module</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="components.html#components.dropdown_list_component.DropdownList"><code class="docutils literal notranslate"><span class="pre">DropdownList</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="components.html#module-components.eventbar_component">components.eventbar_component module</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="components.html#components.eventbar_component.EventPanelComponent"><code class="docutils literal notranslate"><span class="pre">EventPanelComponent</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="components.html#module-components.events_container_component">components.events_container_component module</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="components.html#components.events_container_component.EventsContainerComponent"><code class="docutils literal notranslate"><span class="pre">EventsContainerComponent</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="components.html#module-components.json_container_component">components.json_container_component module</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="components.html#components.json_container_component.JsonContainerComponent"><code class="docutils literal notranslate"><span class="pre">JsonContainerComponent</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="components.html#module-components.modal_window_component">components.modal_window_component module</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="components.html#components.modal_window_component.ModalWindowComponent"><code class="docutils literal notranslate"><span class="pre">ModalWindowComponent</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="components.html#module-components.navbar_component">components.navbar_component module</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="components.html#components.navbar_component.NavigationPanelComponent"><code class="docutils literal notranslate"><span class="pre">NavigationPanelComponent</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="components.html#module-components.table_component">components.table_component module</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="components.html#components.table_component.TableComponent"><code class="docutils literal notranslate"><span class="pre">TableComponent</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="components.html#module-components.toolbar_component">components.toolbar_component module</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="components.html#components.toolbar_component.ToolbarComponent"><code class="docutils literal notranslate"><span class="pre">ToolbarComponent</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="components.html#module-components">Module contents</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="components_derived.html">components_derived package</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="components_derived.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="components_derived.html#module-components_derived.container_system_log_events">components_derived.container_system_log_events module</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="components_derived.html#components_derived.container_system_log_events.SystemLogEventsContainer"><code class="docutils literal notranslate"><span class="pre">SystemLogEventsContainer</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="components_derived.html#module-components_derived.date_input_component">components_derived.date_input_component module</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="components_derived.html#components_derived.date_input_component.DateInput"><code class="docutils literal notranslate"><span class="pre">DateInput</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="components_derived.html#module-components_derived.interactive_dropdown_list">components_derived.interactive_dropdown_list module</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="components_derived.html#components_derived.interactive_dropdown_list.InteractiveDropdownList"><code class="docutils literal notranslate"><span class="pre">InteractiveDropdownList</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="components_derived.html#module-components_derived.modal_add_AD_user">components_derived.modal_add_AD_user module</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="components_derived.html#components_derived.modal_add_AD_user.AddADUserModalWindow"><code class="docutils literal notranslate"><span class="pre">AddADUserModalWindow</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="components_derived.html#module-components_derived.modal_add_local_user">components_derived.modal_add_local_user module</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="components_derived.html#components_derived.modal_add_local_user.AddLocalUserModalWindow"><code class="docutils literal notranslate"><span class="pre">AddLocalUserModalWindow</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="components_derived.html#module-components_derived.modal_change_password">components_derived.modal_change_password module</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="components_derived.html#components_derived.modal_change_password.ChangePasswordModalWindow"><code class="docutils literal notranslate"><span class="pre">ChangePasswordModalWindow</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="components_derived.html#module-components_derived.modal_edit_user">components_derived.modal_edit_user module</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="components_derived.html#components_derived.modal_edit_user.EditUserModalWindow"><code class="docutils literal notranslate"><span class="pre">EditUserModalWindow</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="components_derived.html#module-components_derived.modal_view_template">components_derived.modal_view_template module</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="components_derived.html#components_derived.modal_view_template.ViewTemplateModalWindow"><code class="docutils literal notranslate"><span class="pre">ViewTemplateModalWindow</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="components_derived.html#module-components_derived.modal_view_ztp_template">components_derived.modal_view_ztp_template module</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="components_derived.html#components_derived.modal_view_ztp_template.ViewZTPTemplateModalWindow"><code class="docutils literal notranslate"><span class="pre">ViewZTPTemplateModalWindow</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="components_derived.html#module-components_derived.selection_bar_component">components_derived.selection_bar_component module</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="components_derived.html#components_derived.selection_bar_component.SelectionBarComponent"><code class="docutils literal notranslate"><span class="pre">SelectionBarComponent</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="components_derived.html#module-components_derived.settings_form_component">components_derived.settings_form_component module</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="components_derived.html#components_derived.settings_form_component.SettingsFormComponent"><code class="docutils literal notranslate"><span class="pre">SettingsFormComponent</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="components_derived.html#module-components_derived.sidebar_filter_component">components_derived.sidebar_filter_component module</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="components_derived.html#components_derived.sidebar_filter_component.SidebarFilterComponent"><code class="docutils literal notranslate"><span class="pre">SidebarFilterComponent</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="components_derived.html#module-components_derived.user_card">components_derived.user_card module</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="components_derived.html#components_derived.user_card.UserCard"><code class="docutils literal notranslate"><span class="pre">UserCard</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="components_derived.html#module-components_derived">Module contents</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="conftest.html">conftest module</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="conftest.html#conftest.pytest_sessionfinish"><code class="docutils literal notranslate"><span class="pre">pytest_sessionfinish()</span></code></a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="conftest.html#conftest.pytest_addoption"><code class="docutils literal notranslate"><span class="pre">pytest_addoption()</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="data.html">data package</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="data.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="data.html#module-data.constants">data.constants module</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="data.html#data.constants.Constants"><code class="docutils literal notranslate"><span class="pre">Constants</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="data.html#module-data.environment">data.environment module</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="data.html#data.environment.Environment"><code class="docutils literal notranslate"><span class="pre">Environment</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="data.html#module-data.roles_dict">data.roles_dict module</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="data.html#module-data">Module contents</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="elements.html">elements package</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="elements.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="elements.html#module-elements.base_element">elements.base_element module</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="elements.html#elements.base_element.BaseElement"><code class="docutils literal notranslate"><span class="pre">BaseElement</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="elements.html#module-elements.button_element">elements.button_element module</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="elements.html#elements.button_element.Button"><code class="docutils literal notranslate"><span class="pre">Button</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="elements.html#module-elements.checkbox_element">elements.checkbox_element module</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="elements.html#elements.checkbox_element.Checkbox"><code class="docutils literal notranslate"><span class="pre">Checkbox</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="elements.html#module-elements.icon_element">elements.icon_element module</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="elements.html#elements.icon_element.Icon"><code class="docutils literal notranslate"><span class="pre">Icon</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="elements.html#module-elements.tab_button_element">elements.tab_button_element module</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="elements.html#elements.tab_button_element.TabButton"><code class="docutils literal notranslate"><span class="pre">TabButton</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="elements.html#module-elements.text_element">elements.text_element module</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="elements.html#elements.text_element.Text"><code class="docutils literal notranslate"><span class="pre">Text</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="elements.html#module-elements.text_input_element">elements.text_input_element module</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="elements.html#elements.text_input_element.TextInput"><code class="docutils literal notranslate"><span class="pre">TextInput</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="elements.html#module-elements.tooltip_button_element">elements.tooltip_button_element module</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="elements.html#elements.tooltip_button_element.TooltipButton"><code class="docutils literal notranslate"><span class="pre">TooltipButton</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="elements.html#module-elements">Module contents</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="fixtures.html">fixtures package</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="fixtures.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="fixtures.html#module-fixtures.pages">fixtures.pages module</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="fixtures.html#fixtures.pages.pytest_addoption"><code class="docutils literal notranslate"><span class="pre">pytest_addoption()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="fixtures.html#fixtures.pages.browser"><code class="docutils literal notranslate"><span class="pre">browser()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="fixtures.html#fixtures.pages.get_firefox_browser"><code class="docutils literal notranslate"><span class="pre">get_firefox_browser()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="fixtures.html#fixtures.pages.get_chrome_browser"><code class="docutils literal notranslate"><span class="pre">get_chrome_browser()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="fixtures.html#fixtures.pages.get_remote_chrome"><code class="docutils literal notranslate"><span class="pre">get_remote_chrome()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="fixtures.html#fixtures.pages.get_context"><code class="docutils literal notranslate"><span class="pre">get_context()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="fixtures.html#fixtures.pages.return_back"><code class="docutils literal notranslate"><span class="pre">return_back()</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="fixtures.html#module-fixtures">Module contents</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="pages.html">pages package</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="pages.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="pages.html#module-pages.base_page">pages.base_page module</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="pages.html#pages.base_page.BasePage"><code class="docutils literal notranslate"><span class="pre">BasePage</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="pages.html#module-pages.current_session_tab">pages.current_session_tab module</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="pages.html#pages.current_session_tab.CurrentSessionsTab"><code class="docutils literal notranslate"><span class="pre">CurrentSessionsTab</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="pages.html#module-pages.license_tab">pages.license_tab module</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="pages.html#pages.license_tab.LicenseTab"><code class="docutils literal notranslate"><span class="pre">LicenseTab</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="pages.html#module-pages.login_page">pages.login_page module</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="pages.html#pages.login_page.LoginPage"><code class="docutils literal notranslate"><span class="pre">LoginPage</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="pages.html#module-pages.main_page">pages.main_page module</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="pages.html#pages.main_page.MainPage"><code class="docutils literal notranslate"><span class="pre">MainPage</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="pages.html#module-pages.push_notifications_settings_tab">pages.push_notifications_settings_tab module</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="pages.html#pages.push_notifications_settings_tab.PushNotificationsSettingsTab"><code class="docutils literal notranslate"><span class="pre">PushNotificationsSettingsTab</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="pages.html#module-pages.service_status_tab">pages.service_status_tab module</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="pages.html#pages.service_status_tab.ServiceStatusTab"><code class="docutils literal notranslate"><span class="pre">ServiceStatusTab</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="pages.html#module-pages.session_settings_tab">pages.session_settings_tab module</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="pages.html#pages.session_settings_tab.SessionSettingsTab"><code class="docutils literal notranslate"><span class="pre">SessionSettingsTab</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="pages.html#module-pages.templates_tab">pages.templates_tab module</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="pages.html#pages.templates_tab.TemplatesTab"><code class="docutils literal notranslate"><span class="pre">TemplatesTab</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="pages.html#module-pages.users_tab">pages.users_tab module</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="pages.html#pages.users_tab.UsersTab"><code class="docutils literal notranslate"><span class="pre">UsersTab</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="pages.html#module-pages.ztp_config_tab">pages.ztp_config_tab module</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="pages.html#pages.ztp_config_tab.ZTPConfigTab"><code class="docutils literal notranslate"><span class="pre">ZTPConfigTab</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="pages.html#module-pages.ztp_templates_tab">pages.ztp_templates_tab module</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="pages.html#pages.ztp_templates_tab.ZTPTemplatesTab"><code class="docutils literal notranslate"><span class="pre">ZTPTemplatesTab</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="pages.html#module-pages">Module contents</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="tools.html">tools package</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="tools.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="tools.html#module-tools.fix_python_project">tools.fix_python_project module</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="tools.html#tools.fix_python_project.ProjectFixer"><code class="docutils literal notranslate"><span class="pre">ProjectFixer</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="tools.html#module-tools.logger">tools.logger module</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="tools.html#tools.logger.get_logger"><code class="docutils literal notranslate"><span class="pre">get_logger()</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="tools.html#module-tools">Module contents</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<p class="caption" role="heading"><span class="caption-text">Документация и руководства:</span></p>
|
||
<ul class="current">
|
||
<li class="toctree-l1 current"><a class="current reference internal" href="#">Руководство по документации тестов с помощью Sphinx</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="#id2">1 Расположение документа</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#id3">2 Первичная настройка для нового проекта</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="#id4">2.1 Подготовка зависимостей</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#id5">2.2 Инициализация Sphinx</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#id6">2.3 Настройка конфигурации</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#id7">2.4 Настройка главной страницы</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#id8">3 Работа с существующим проектом</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="#id9">3.1 Установка зависимостей</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#id10">3.2 Генерация документации</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#id11">3.2.1 Базовая генерация</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#id12">3.2.2 Генерация с исключениями</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#id13">3.2.3 Принудительная перегенерация</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#id14">3.3 Очистка документации</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#id15">3.3.1 Команды очистки</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#id16">3.3.2 Автоматизация очистки</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#id17">3.4 Сборка и деплой</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#id18">3.4.1 Локальная сборка</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#id19">3.4.2 Проверка качества</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#id20">3.4.3 Сборка для публикации</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#ci-cd">3.4.4 Настройка для CI/CD</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#mkdocs-sphinx">4 Конвертация контента из MkDocs в Sphinx</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="#id21">4.1 Текст</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#id22">4.2 Таблицы</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#id23">5 Особенности Sphinx</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="#docstrings">5.1 Поддержка docstrings</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#id24">5.2 Кастомные директивы</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#id25">6 Решение проблем</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="#id26">6.1 Проблема: Модули не находятся</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#id27">6.2 Проблема: Не генерируются docstrings</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#id28">6.3 Проблема: Тема не применяется</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#id29">7 Дополнительные возможности</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#version-history">История версий</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
|
||
</div>
|
||
</div>
|
||
</nav>
|
||
|
||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Меню навигации для мобильных устройств" >
|
||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||
<a href="index.html">e-nms-qa-automation</a>
|
||
</nav>
|
||
|
||
<div class="wy-nav-content">
|
||
<div class="rst-content">
|
||
<div role="navigation" aria-label="Навигация по страницам">
|
||
<ul class="wy-breadcrumbs">
|
||
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||
<li class="breadcrumb-item active">Руководство по документации тестов с помощью Sphinx</li>
|
||
<li class="wy-breadcrumbs-aside">
|
||
<a href="_sources/sphinx_guide.rst.txt" rel="nofollow"> Просмотреть исходный код страницы</a>
|
||
</li>
|
||
</ul>
|
||
<hr/>
|
||
</div>
|
||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||
<div itemprop="articleBody">
|
||
|
||
<section id="sphinx">
|
||
<h1>Руководство по документации тестов с помощью Sphinx<a class="headerlink" href="#sphinx" title="Ссылка на этот заголовок"></a></h1>
|
||
<p><strong>Версия документа:</strong> 1.0
|
||
<strong>Дата последнего обновления:</strong> 2025-11-27</p>
|
||
<nav class="contents local" id="id1">
|
||
<p class="topic-title">Содержание</p>
|
||
<ul class="simple">
|
||
<li><p><a class="reference internal" href="#id2" id="id31">1 Расположение документа</a></p></li>
|
||
<li><p><a class="reference internal" href="#id3" id="id32">2 Первичная настройка для нового проекта</a></p>
|
||
<ul>
|
||
<li><p><a class="reference internal" href="#id4" id="id33">2.1 Подготовка зависимостей</a></p></li>
|
||
<li><p><a class="reference internal" href="#id5" id="id34">2.2 Инициализация Sphinx</a></p></li>
|
||
<li><p><a class="reference internal" href="#id6" id="id35">2.3 Настройка конфигурации</a></p></li>
|
||
<li><p><a class="reference internal" href="#id7" id="id36">2.4 Настройка главной страницы</a></p></li>
|
||
</ul>
|
||
</li>
|
||
<li><p><a class="reference internal" href="#id8" id="id37">3 Работа с существующим проектом</a></p>
|
||
<ul>
|
||
<li><p><a class="reference internal" href="#id9" id="id38">3.1 Установка зависимостей</a></p></li>
|
||
<li><p><a class="reference internal" href="#id10" id="id39">3.2 Генерация документации</a></p>
|
||
<ul>
|
||
<li><p><a class="reference internal" href="#id11" id="id40">3.2.1 Базовая генерация</a></p></li>
|
||
<li><p><a class="reference internal" href="#id12" id="id41">3.2.2 Генерация с исключениями</a></p></li>
|
||
<li><p><a class="reference internal" href="#id13" id="id42">3.2.3 Принудительная перегенерация</a></p></li>
|
||
</ul>
|
||
</li>
|
||
<li><p><a class="reference internal" href="#id14" id="id43">3.3 Очистка документации</a></p>
|
||
<ul>
|
||
<li><p><a class="reference internal" href="#id15" id="id44">3.3.1 Команды очистки</a></p></li>
|
||
<li><p><a class="reference internal" href="#id16" id="id45">3.3.2 Автоматизация очистки</a></p></li>
|
||
</ul>
|
||
</li>
|
||
<li><p><a class="reference internal" href="#id17" id="id46">3.4 Сборка и деплой</a></p>
|
||
<ul>
|
||
<li><p><a class="reference internal" href="#id18" id="id47">3.4.1 Локальная сборка</a></p></li>
|
||
<li><p><a class="reference internal" href="#id19" id="id48">3.4.2 Проверка качества</a></p></li>
|
||
<li><p><a class="reference internal" href="#id20" id="id49">3.4.3 Сборка для публикации</a></p></li>
|
||
<li><p><a class="reference internal" href="#ci-cd" id="id50">3.4.4 Настройка для CI/CD</a></p></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li><p><a class="reference internal" href="#mkdocs-sphinx" id="id51">4 Конвертация контента из MkDocs в Sphinx</a></p>
|
||
<ul>
|
||
<li><p><a class="reference internal" href="#id21" id="id52">4.1 Текст</a></p></li>
|
||
<li><p><a class="reference internal" href="#id22" id="id53">4.2 Таблицы</a></p></li>
|
||
</ul>
|
||
</li>
|
||
<li><p><a class="reference internal" href="#id23" id="id54">5 Особенности Sphinx</a></p>
|
||
<ul>
|
||
<li><p><a class="reference internal" href="#docstrings" id="id55">5.1 Поддержка docstrings</a></p></li>
|
||
<li><p><a class="reference internal" href="#id24" id="id56">5.2 Кастомные директивы</a></p></li>
|
||
</ul>
|
||
</li>
|
||
<li><p><a class="reference internal" href="#id25" id="id57">6 Решение проблем</a></p>
|
||
<ul>
|
||
<li><p><a class="reference internal" href="#id26" id="id58">6.1 Проблема: Модули не находятся</a></p></li>
|
||
<li><p><a class="reference internal" href="#id27" id="id59">6.2 Проблема: Не генерируются docstrings</a></p></li>
|
||
<li><p><a class="reference internal" href="#id28" id="id60">6.3 Проблема: Тема не применяется</a></p></li>
|
||
</ul>
|
||
</li>
|
||
<li><p><a class="reference internal" href="#id29" id="id61">7 Дополнительные возможности</a></p></li>
|
||
<li><p><a class="reference internal" href="#version-history" id="id62">История версий</a></p></li>
|
||
</ul>
|
||
</nav>
|
||
<section id="id2">
|
||
<h2><a class="toc-backref" href="#id31" role="doc-backlink">1 Расположение документа</a><a class="headerlink" href="#id2" title="Ссылка на этот заголовок"></a></h2>
|
||
<p>Данное руководство расположено в структуре проекта по пути:</p>
|
||
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>project_root/
|
||
├── docs/
|
||
│ ├── source/
|
||
│ │ ├── conf.py
|
||
│ │ ├── index.rst
|
||
│ │ ├── sphinx_guide.rst <-- Этот файл
|
||
│ │ └── modules.rst
|
||
│ └── build/
|
||
├── src/
|
||
│ └── your_package/
|
||
└── pyproject.toml
|
||
</pre></div>
|
||
</div>
|
||
</section>
|
||
<section id="id3">
|
||
<h2><a class="toc-backref" href="#id32" role="doc-backlink">2 Первичная настройка для нового проекта</a><a class="headerlink" href="#id3" title="Ссылка на этот заголовок"></a></h2>
|
||
<section id="id4">
|
||
<h3><a class="toc-backref" href="#id33" role="doc-backlink">2.1 Подготовка зависимостей</a><a class="headerlink" href="#id4" title="Ссылка на этот заголовок"></a></h3>
|
||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="c1"># Установка Sphinx и тем</span>
|
||
pip<span class="w"> </span>install<span class="w"> </span>sphinx<span class="w"> </span>sphinx-rtd-theme<span class="w"> </span>myst-parser
|
||
|
||
<span class="c1"># Добавление в pyproject.toml</span>
|
||
<span class="nb">echo</span><span class="w"> </span><span class="o">[</span>project.optional-dependencies<span class="o">]</span><span class="w"> </span>>><span class="w"> </span>pyproject.toml
|
||
<span class="nb">echo</span><span class="w"> </span><span class="nv">docs</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="o">[</span><span class="w"> </span>>><span class="w"> </span>pyproject.toml
|
||
<span class="nb">echo</span><span class="w"> </span><span class="s2">"sphinx>=8.2.3"</span>,<span class="w"> </span>>><span class="w"> </span>pyproject.toml
|
||
<span class="nb">echo</span><span class="w"> </span><span class="s2">"sphinx-rtd-theme>=2.0.0"</span>,<span class="w"> </span>>><span class="w"> </span>pyproject.toml
|
||
<span class="nb">echo</span><span class="w"> </span><span class="s2">"myst-parser>=2.0.0"</span><span class="w"> </span>>><span class="w"> </span>pyproject.toml
|
||
<span class="nb">echo</span><span class="w"> </span><span class="o">]</span><span class="w"> </span>>><span class="w"> </span>pyproject.toml
|
||
</pre></div>
|
||
</div>
|
||
</section>
|
||
<section id="id5">
|
||
<h3><a class="toc-backref" href="#id34" role="doc-backlink">2.2 Инициализация Sphinx</a><a class="headerlink" href="#id5" title="Ссылка на этот заголовок"></a></h3>
|
||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="c1"># Создание структуры документации</span>
|
||
sphinx-quickstart<span class="w"> </span>docs<span class="w"> </span>--sep<span class="w"> </span>-p<span class="w"> </span><span class="s2">"PROJECT_NAME"</span><span class="w"> </span>-a<span class="w"> </span><span class="s2">"TEAM_NAME"</span><span class="w"> </span>-l<span class="w"> </span>ru<span class="w"> </span>--ext-autodoc<span class="w"> </span>--ext-viewcode<span class="w"> </span>--makefile<span class="w"> </span>--no-batchfile
|
||
</pre></div>
|
||
</div>
|
||
</section>
|
||
<section id="id6">
|
||
<h3><a class="toc-backref" href="#id35" role="doc-backlink">2.3 Настройка конфигурации</a><a class="headerlink" href="#id6" title="Ссылка на этот заголовок"></a></h3>
|
||
<p>Обновите <code class="docutils literal notranslate"><span class="pre">docs/source/conf.py</span></code>:</p>
|
||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span><span class="w"> </span><span class="nn">os</span>
|
||
<span class="kn">import</span><span class="w"> </span><span class="nn">sys</span>
|
||
<span class="n">sys</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">insert</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">abspath</span><span class="p">(</span><span class="s1">'../..'</span><span class="p">))</span>
|
||
|
||
<span class="n">extensions</span> <span class="o">=</span> <span class="p">[</span>
|
||
<span class="s1">'sphinx.ext.autodoc'</span><span class="p">,</span>
|
||
<span class="s1">'sphinx.ext.napoleon'</span><span class="p">,</span>
|
||
<span class="s1">'sphinx.ext.viewcode'</span><span class="p">,</span>
|
||
<span class="s1">'sphinx.ext.intersphinx'</span><span class="p">,</span>
|
||
<span class="s1">'sphinx_rtd_theme'</span><span class="p">,</span>
|
||
<span class="p">]</span>
|
||
|
||
<span class="n">autodoc_default_options</span> <span class="o">=</span> <span class="p">{</span>
|
||
<span class="s1">'members'</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span>
|
||
<span class="s1">'member-order'</span><span class="p">:</span> <span class="s1">'bysource'</span><span class="p">,</span>
|
||
<span class="s1">'special-members'</span><span class="p">:</span> <span class="s1">'__init__'</span><span class="p">,</span>
|
||
<span class="s1">'undoc-members'</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span>
|
||
<span class="s1">'exclude-members'</span><span class="p">:</span> <span class="s1">'__weakref__'</span>
|
||
<span class="p">}</span>
|
||
|
||
<span class="n">autodoc_typehints</span> <span class="o">=</span> <span class="s1">'description'</span>
|
||
<span class="n">napoleon_google_docstring</span> <span class="o">=</span> <span class="kc">True</span>
|
||
<span class="n">napoleon_numpy_docstring</span> <span class="o">=</span> <span class="kc">False</span>
|
||
<span class="n">html_theme</span> <span class="o">=</span> <span class="s1">'sphinx_rtd_theme'</span>
|
||
</pre></div>
|
||
</div>
|
||
</section>
|
||
<section id="id7">
|
||
<h3><a class="toc-backref" href="#id36" role="doc-backlink">2.4 Настройка главной страницы</a><a class="headerlink" href="#id7" title="Ссылка на этот заголовок"></a></h3>
|
||
<p>Обновите <code class="docutils literal notranslate"><span class="pre">docs/source/index.rst</span></code>:</p>
|
||
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span><span class="gh">Документация проекта</span>
|
||
<span class="gh">====================</span>
|
||
|
||
<span class="p">..</span> <span class="ow">toctree</span><span class="p">::</span>
|
||
<span class="nc">:maxdepth:</span> 3
|
||
<span class="nc">:caption:</span> Содержание:
|
||
|
||
modules
|
||
|
||
<span class="gh">Инструкции и процессы</span>
|
||
<span class="gh">---------------------</span>
|
||
|
||
<span class="p">..</span> <span class="ow">toctree</span><span class="p">::</span>
|
||
<span class="nc">:maxdepth:</span> 2
|
||
<span class="nc">:caption:</span> Документация и руководства:
|
||
|
||
sphinx_guide
|
||
|
||
<span class="gh">Описание</span>
|
||
<span class="gh">-----------</span>
|
||
Основная документация проекта.
|
||
|
||
<span class="gh">Индексы</span>
|
||
<span class="gh">=======</span>
|
||
|
||
<span class="m">*</span> <span class="na">:ref:</span><span class="nv">`genindex`</span>
|
||
<span class="m">*</span> <span class="na">:ref:</span><span class="nv">`modindex`</span>
|
||
<span class="m">*</span> <span class="na">:ref:</span><span class="nv">`search`</span>
|
||
</pre></div>
|
||
</div>
|
||
</section>
|
||
</section>
|
||
<section id="id8">
|
||
<h2><a class="toc-backref" href="#id37" role="doc-backlink">3 Работа с существующим проектом</a><a class="headerlink" href="#id8" title="Ссылка на этот заголовок"></a></h2>
|
||
<p><strong>Примечание:</strong> Для работы с существующим проектом требуется установка Sphinx на локальной машине.</p>
|
||
<section id="id9">
|
||
<h3><a class="toc-backref" href="#id38" role="doc-backlink">3.1 Установка зависимостей</a><a class="headerlink" href="#id9" title="Ссылка на этот заголовок"></a></h3>
|
||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="c1"># Установка Sphinx и необходимых расширений</span>
|
||
pip<span class="w"> </span>install<span class="w"> </span>sphinx<span class="w"> </span>sphinx-rtd-theme<span class="w"> </span>myst-parser
|
||
|
||
<span class="c1"># Или установка из зависимостей проекта (если настроено в pyproject.toml)</span>
|
||
pip<span class="w"> </span>install<span class="w"> </span>-e<span class="w"> </span><span class="s2">".[docs]"</span>
|
||
</pre></div>
|
||
</div>
|
||
</section>
|
||
<section id="id10">
|
||
<h3><a class="toc-backref" href="#id39" role="doc-backlink">3.2 Генерация документации</a><a class="headerlink" href="#id10" title="Ссылка на этот заголовок"></a></h3>
|
||
<section id="id11">
|
||
<h4><a class="toc-backref" href="#id40" role="doc-backlink">3.2.1 Базовая генерация</a><a class="headerlink" href="#id11" title="Ссылка на этот заголовок"></a></h4>
|
||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="c1"># Генерация .rst файлов из структуры проекта</span>
|
||
sphinx-apidoc<span class="w"> </span>-o<span class="w"> </span>docs/source<span class="w"> </span>.<span class="w"> </span>-f
|
||
|
||
<span class="c1"># Сборка HTML документации</span>
|
||
sphinx-build<span class="w"> </span>-b<span class="w"> </span>html<span class="w"> </span>docs/source<span class="w"> </span>docs/build/html
|
||
</pre></div>
|
||
</div>
|
||
</section>
|
||
<section id="id12">
|
||
<h4><a class="toc-backref" href="#id41" role="doc-backlink">3.2.2 Генерация с исключениями</a><a class="headerlink" href="#id12" title="Ссылка на этот заголовок"></a></h4>
|
||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="c1"># Исключение определенных папок из документации</span>
|
||
sphinx-apidoc<span class="w"> </span>-o<span class="w"> </span>docs/source<span class="w"> </span>.<span class="w"> </span>-f<span class="w"> </span>--exclude<span class="w"> </span>tests/<span class="w"> </span>--exclude<span class="w"> </span>migrations/
|
||
</pre></div>
|
||
</div>
|
||
</section>
|
||
<section id="id13">
|
||
<h4><a class="toc-backref" href="#id42" role="doc-backlink">3.2.3 Принудительная перегенерация</a><a class="headerlink" href="#id13" title="Ссылка на этот заголовок"></a></h4>
|
||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="c1"># Принудительная перезапись существующих файлов</span>
|
||
sphinx-apidoc<span class="w"> </span>-o<span class="w"> </span>docs/source<span class="w"> </span>.<span class="w"> </span>-f<span class="w"> </span>--force
|
||
</pre></div>
|
||
</div>
|
||
</section>
|
||
</section>
|
||
<section id="id14">
|
||
<h3><a class="toc-backref" href="#id43" role="doc-backlink">3.3 Очистка документации</a><a class="headerlink" href="#id14" title="Ссылка на этот заголовок"></a></h3>
|
||
<p>Когда требуется очистка:</p>
|
||
<ul class="simple">
|
||
<li><p><strong>После удаления модулей</strong> - чтобы убрать ссылки на несуществующие файлы</p></li>
|
||
<li><p><strong>После переименования пакетов</strong> - для актуализации структуры</p></li>
|
||
<li><p><strong>При изменении архитектуры проекта</strong> - для отражения новых модулей</p></li>
|
||
<li><p><strong>При появлении предупреждений</strong> о несуществующих модулях</p></li>
|
||
</ul>
|
||
<section id="id15">
|
||
<h4><a class="toc-backref" href="#id44" role="doc-backlink">3.3.1 Команды очистки</a><a class="headerlink" href="#id15" title="Ссылка на этот заголовок"></a></h4>
|
||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="c1"># Удаление старых сгенерированных .rst файлов кроме основных</span>
|
||
rm<span class="w"> </span>docs/source/modules.rst
|
||
rm<span class="w"> </span>docs/source/pages.rst
|
||
rm<span class="w"> </span>docs/source/components.rst
|
||
|
||
<span class="c1"># Удаление всех .rst файлов кроме основных (Linux/Mac)</span>
|
||
find<span class="w"> </span>docs/source<span class="w"> </span>-name<span class="w"> </span><span class="s2">"*.rst"</span><span class="w"> </span>!<span class="w"> </span>-name<span class="w"> </span><span class="s2">"index.rst"</span><span class="w"> </span>!<span class="w"> </span>-name<span class="w"> </span><span class="s2">"sphinx_guide.rst"</span><span class="w"> </span>-delete
|
||
|
||
<span class="c1"># Удаление всех .rst файлов кроме основных (Windows PowerShell)</span>
|
||
Get-ChildItem<span class="w"> </span>docs/source<span class="w"> </span>-Filter<span class="w"> </span><span class="s2">"*.rst"</span><span class="w"> </span><span class="p">|</span><span class="w"> </span>Where-Object<span class="w"> </span><span class="o">{</span><span class="w"> </span><span class="nv">$_</span>.Name<span class="w"> </span>-notin<span class="w"> </span>@<span class="o">(</span><span class="s2">"index.rst"</span>,<span class="w"> </span><span class="s2">"sphinx_guide.rst"</span><span class="o">)</span><span class="w"> </span><span class="o">}</span><span class="w"> </span><span class="p">|</span><span class="w"> </span>Remove-Item
|
||
</pre></div>
|
||
</div>
|
||
</section>
|
||
<section id="id16">
|
||
<h4><a class="toc-backref" href="#id45" role="doc-backlink">3.3.2 Автоматизация очистки</a><a class="headerlink" href="#id16" title="Ссылка на этот заголовок"></a></h4>
|
||
<div class="highlight-makefile notranslate"><div class="highlight"><pre><span></span><span class="nf">.PHONY</span><span class="o">:</span><span class="w"> </span><span class="n">clean</span>-<span class="n">docs</span> <span class="n">rebuild</span>-<span class="n">docs</span>
|
||
|
||
<span class="nf">clean-docs</span><span class="o">:</span>
|
||
<span class="w"> </span>rm<span class="w"> </span>-rf<span class="w"> </span>docs/build/
|
||
<span class="w"> </span>find<span class="w"> </span>docs/source<span class="w"> </span>-name<span class="w"> </span><span class="s2">"*.rst"</span><span class="w"> </span>!<span class="w"> </span>-name<span class="w"> </span><span class="s2">"index.rst"</span><span class="w"> </span>!<span class="w"> </span>-name<span class="w"> </span><span class="s2">"sphinx_guide.rst"</span><span class="w"> </span>-delete
|
||
|
||
<span class="nf">rebuild-docs</span><span class="o">:</span><span class="w"> </span><span class="n">clean</span>-<span class="n">docs</span>
|
||
<span class="w"> </span>sphinx-apidoc<span class="w"> </span>-o<span class="w"> </span>docs/source<span class="w"> </span>.<span class="w"> </span>-f
|
||
<span class="w"> </span>sphinx-build<span class="w"> </span>-b<span class="w"> </span>html<span class="w"> </span>docs/source<span class="w"> </span>docs/build/html
|
||
</pre></div>
|
||
</div>
|
||
</section>
|
||
</section>
|
||
<section id="id17">
|
||
<h3><a class="toc-backref" href="#id46" role="doc-backlink">3.4 Сборка и деплой</a><a class="headerlink" href="#id17" title="Ссылка на этот заголовок"></a></h3>
|
||
<section id="id18">
|
||
<h4><a class="toc-backref" href="#id47" role="doc-backlink">3.4.1 Локальная сборка</a><a class="headerlink" href="#id18" title="Ссылка на этот заголовок"></a></h4>
|
||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="c1"># Базовая сборка HTML</span>
|
||
sphinx-build<span class="w"> </span>-b<span class="w"> </span>html<span class="w"> </span>docs/source<span class="w"> </span>docs/build/html
|
||
|
||
<span class="c1"># Сборка с автоматическим обновлением</span>
|
||
sphinx-autobuild<span class="w"> </span>docs/source<span class="w"> </span>docs/build/html
|
||
</pre></div>
|
||
</div>
|
||
</section>
|
||
<section id="id19">
|
||
<h4><a class="toc-backref" href="#id48" role="doc-backlink">3.4.2 Проверка качества</a><a class="headerlink" href="#id19" title="Ссылка на этот заголовок"></a></h4>
|
||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="c1"># Проверка ссылок</span>
|
||
sphinx-build<span class="w"> </span>-b<span class="w"> </span>linkcheck<span class="w"> </span>docs/source<span class="w"> </span>docs/build/linkcheck
|
||
|
||
<span class="c1"># Проверка орфографии (требуется установка sphinxcontrib-spelling)</span>
|
||
sphinx-build<span class="w"> </span>-b<span class="w"> </span>spelling<span class="w"> </span>docs/source<span class="w"> </span>docs/build/spelling
|
||
</pre></div>
|
||
</div>
|
||
</section>
|
||
<section id="id20">
|
||
<h4><a class="toc-backref" href="#id49" role="doc-backlink">3.4.3 Сборка для публикации</a><a class="headerlink" href="#id20" title="Ссылка на этот заголовок"></a></h4>
|
||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="c1"># Сборка PDF (требуется LaTeX)</span>
|
||
sphinx-build<span class="w"> </span>-b<span class="w"> </span>latex<span class="w"> </span>docs/source<span class="w"> </span>docs/build/latex
|
||
|
||
<span class="c1"># Сборка EPUB</span>
|
||
sphinx-build<span class="w"> </span>-b<span class="w"> </span>epub<span class="w"> </span>docs/source<span class="w"> </span>docs/build/epub
|
||
</pre></div>
|
||
</div>
|
||
</section>
|
||
<section id="ci-cd">
|
||
<h4><a class="toc-backref" href="#id50" role="doc-backlink">3.4.4 Настройка для CI/CD</a><a class="headerlink" href="#ci-cd" title="Ссылка на этот заголовок"></a></h4>
|
||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="c1"># Игнорирование билд-папки в Git</span>
|
||
<span class="nb">echo</span><span class="w"> </span><span class="s2">"docs/_build/html/"</span><span class="w"> </span>>><span class="w"> </span>.gitignore
|
||
<span class="nb">echo</span><span class="w"> </span><span class="s2">"docs/_build/latex/"</span><span class="w"> </span>>><span class="w"> </span>.gitignore
|
||
</pre></div>
|
||
</div>
|
||
</section>
|
||
</section>
|
||
</section>
|
||
<section id="mkdocs-sphinx">
|
||
<h2><a class="toc-backref" href="#id51" role="doc-backlink">4 Конвертация контента из MkDocs в Sphinx</a><a class="headerlink" href="#mkdocs-sphinx" title="Ссылка на этот заголовок"></a></h2>
|
||
<section id="id21">
|
||
<h3><a class="toc-backref" href="#id52" role="doc-backlink">4.1 Текст</a><a class="headerlink" href="#id21" title="Ссылка на этот заголовок"></a></h3>
|
||
<p><strong>MkDocs (markdown):</strong></p>
|
||
<div class="highlight-markdown notranslate"><div class="highlight"><pre><span></span><span class="gh"># Заголовок</span>
|
||
Текст с <span class="gs">**жирным**</span> шрифтом.
|
||
<span class="k">-</span><span class="w"> </span>Элемент списка 1
|
||
<span class="k">-</span><span class="w"> </span>Элемент списка 2
|
||
</pre></div>
|
||
</div>
|
||
<p><strong>Sphinx (reStructuredText):</strong></p>
|
||
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span><span class="gh">Заголовок</span>
|
||
<span class="gh">=========</span>
|
||
Текст с <span class="gs">**жирным**</span> шрифтом.
|
||
<span class="m">*</span> Элемент списка 1
|
||
<span class="m">*</span> Элемент списка 2
|
||
</pre></div>
|
||
</div>
|
||
</section>
|
||
<section id="id22">
|
||
<h3><a class="toc-backref" href="#id53" role="doc-backlink">4.2 Таблицы</a><a class="headerlink" href="#id22" title="Ссылка на этот заголовок"></a></h3>
|
||
<p><strong>MkDocs:</strong></p>
|
||
<div class="highlight-markdown notranslate"><div class="highlight"><pre><span></span>| Заголовок 1 | Заголовок 2 |
|
||
|-------------|-------------|
|
||
| Данные 1 | Данные 2 |
|
||
</pre></div>
|
||
</div>
|
||
<p><strong>Sphinx:</strong></p>
|
||
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span>+-------------+-------------+
|
||
<span class="o">|</span> Заголовок 1 | Заголовок 2 |
|
||
+=============+=============+
|
||
<span class="o">|</span> Данные 1 | Данные 2 |
|
||
+-------------+-------------+
|
||
</pre></div>
|
||
</div>
|
||
</section>
|
||
</section>
|
||
<section id="id23">
|
||
<h2><a class="toc-backref" href="#id54" role="doc-backlink">5 Особенности Sphinx</a><a class="headerlink" href="#id23" title="Ссылка на этот заголовок"></a></h2>
|
||
<section id="docstrings">
|
||
<h3><a class="toc-backref" href="#id55" role="doc-backlink">5.1 Поддержка docstrings</a><a class="headerlink" href="#docstrings" title="Ссылка на этот заголовок"></a></h3>
|
||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="k">def</span><span class="w"> </span><span class="nf">my_function</span><span class="p">(</span><span class="n">param1</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">param2</span><span class="p">:</span> <span class="nb">int</span><span class="p">)</span> <span class="o">-></span> <span class="nb">bool</span><span class="p">:</span>
|
||
<span class="w"> </span><span class="sd">"""</span>
|
||
<span class="sd"> Краткое описание функции.</span>
|
||
|
||
<span class="sd"> Args:</span>
|
||
<span class="sd"> param1: Описание параметра 1</span>
|
||
<span class="sd"> param2: Описание параметра 2</span>
|
||
|
||
<span class="sd"> Returns:</span>
|
||
<span class="sd"> bool: Описание возвращаемого значения</span>
|
||
|
||
<span class="sd"> Example:</span>
|
||
<span class="sd"> >>> my_function("test", 5)</span>
|
||
<span class="sd"> True</span>
|
||
<span class="sd"> """</span>
|
||
<span class="k">return</span> <span class="kc">True</span>
|
||
</pre></div>
|
||
</div>
|
||
</section>
|
||
<section id="id24">
|
||
<h3><a class="toc-backref" href="#id56" role="doc-backlink">5.2 Кастомные директивы</a><a class="headerlink" href="#id24" title="Ссылка на этот заголовок"></a></h3>
|
||
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span><span class="p">..</span> <span class="ow">note</span><span class="p">::</span>
|
||
Это важное примечание.
|
||
|
||
<span class="p">..</span> <span class="ow">warning</span><span class="p">::</span>
|
||
Это предупреждение.
|
||
|
||
<span class="p">..</span> <span class="ow">code-block</span><span class="p">::</span> <span class="k">python</span>
|
||
|
||
<span class="k">def</span><span class="w"> </span><span class="nf">example</span><span class="p">():</span>
|
||
<span class="nb">print</span><span class="p">(</span><span class="s2">"Hello Sphinx!"</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
</section>
|
||
</section>
|
||
<section id="id25">
|
||
<h2><a class="toc-backref" href="#id57" role="doc-backlink">6 Решение проблем</a><a class="headerlink" href="#id25" title="Ссылка на этот заголовок"></a></h2>
|
||
<section id="id26">
|
||
<h3><a class="toc-backref" href="#id58" role="doc-backlink">6.1 Проблема: Модули не находятся</a><a class="headerlink" href="#id26" title="Ссылка на этот заголовок"></a></h3>
|
||
<p><strong>Решение:</strong> Проверьте <code class="docutils literal notranslate"><span class="pre">sys.path</span></code> в <code class="docutils literal notranslate"><span class="pre">conf.py</span></code></p>
|
||
</section>
|
||
<section id="id27">
|
||
<h3><a class="toc-backref" href="#id59" role="doc-backlink">6.2 Проблема: Не генерируются docstrings</a><a class="headerlink" href="#id27" title="Ссылка на этот заголовок"></a></h3>
|
||
<p><strong>Решение:</strong> Убедитесь, что установлены расширения <code class="docutils literal notranslate"><span class="pre">autodoc</span></code> и <code class="docutils literal notranslate"><span class="pre">napoleon</span></code></p>
|
||
</section>
|
||
<section id="id28">
|
||
<h3><a class="toc-backref" href="#id60" role="doc-backlink">6.3 Проблема: Тема не применяется</a><a class="headerlink" href="#id28" title="Ссылка на этот заголовок"></a></h3>
|
||
<p><strong>Решение:</strong> Проверьте <code class="docutils literal notranslate"><span class="pre">html_theme</span></code> в <code class="docutils literal notranslate"><span class="pre">conf.py</span></code></p>
|
||
</section>
|
||
</section>
|
||
<section id="id29">
|
||
<h2><a class="toc-backref" href="#id61" role="doc-backlink">7 Дополнительные возможности</a><a class="headerlink" href="#id29" title="Ссылка на этот заголовок"></a></h2>
|
||
<ul class="simple">
|
||
<li><p><strong>Autosummary</strong> - автоматические summary таблицы</p></li>
|
||
<li><p><strong>Intersphinx</strong> - ссылки между проектами</p></li>
|
||
<li><p><strong>Custom domains</strong> - домены для специфичной документации</p></li>
|
||
</ul>
|
||
</section>
|
||
<section id="version-history">
|
||
<span id="id30"></span><h2><a class="toc-backref" href="#id62" role="doc-backlink">История версий</a><a class="headerlink" href="#version-history" title="Ссылка на этот заголовок"></a></h2>
|
||
<table class="docutils align-default">
|
||
<thead>
|
||
<tr class="row-odd"><th class="head"><p>Версия</p></th>
|
||
<th class="head"><p>Дата</p></th>
|
||
<th class="head"><p>Изменения</p></th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr class="row-even"><td><p>1.0</p></td>
|
||
<td><p>2025-11-27</p></td>
|
||
<td><p>Первоначальная версия руководства</p></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</section>
|
||
</section>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Нижняя область">
|
||
<a href="tools.html" class="btn btn-neutral float-left" title="tools package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Предыдущая</a>
|
||
</div>
|
||
|
||
<hr/>
|
||
|
||
<div role="contentinfo">
|
||
<p>© Авторские права 2025, NPO KIS. </p>
|
||
</div>
|
||
|
||
Собрано при помощи <a href="https://www.sphinx-doc.org/">Sphinx</a> с использованием
|
||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">темы,</a>
|
||
предоставленной <a href="https://readthedocs.org">Read the Docs</a>.
|
||
|
||
|
||
</footer>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<script>
|
||
jQuery(function () {
|
||
SphinxRtdTheme.Navigation.enable(true);
|
||
});
|
||
</script>
|
||
|
||
</body>
|
||
</html> |