Added docs generator, splitted methods

This commit is contained in:
2025-03-11 20:32:16 +03:00
parent 59f420c725
commit 60d29724b6
12 changed files with 278 additions and 37 deletions

30
docs/setup.rst Normal file
View File

@@ -0,0 +1,30 @@
=========
Установка
=========
Для установки необходимо иметь доступ в корпоративный `Gitlab <https://git.selectel.org>`_, чтобы получить доступ к Registry PyPi.
Установка через pip
-------------------
Выполните ``pip install kontur-focus --index-url https://__token__:<your_personal_token>@git.selectel.org/api/v4/projects/6350/packages/pypi/simple``
Где `<your_personal_token>` - `персональный токен <https://git.selectel.org/help/user/profile/personal_access_tokens>`_ доступа Gitlab.
Использование requirements.txt
------------------------------
Перед использованием необходимо настроить Registry.
Создайте файл `.pypirc` в папке пользователя и добавьте параметры репозитория:
.. code-block:: console
[gitlab]
repository = https://git.selectel.org/api/v4/projects/6350/packages/pypi
username = __token__
password = <your personal access token>
Более подробно `тут <https://git.selectel.org/help/user/packages/pypi_repository/index>`_.
После выполните ``pip install -r requirements.txt``