Added docs generator, splitted methods

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/conf.py

@@ -0,0 +1,39 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = 'Kontur Focus Library'
+copyright = '2025, Ilya Sapunov'
+author = 'Ilya Sapunov'
+release = '0.1.0'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+import sys
+from pathlib import Path
+
+sys.path.insert(0, str(Path('..', '..', 'kontur-focus-lib').resolve()))
+
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.viewcode',
+    'sphinx.ext.todo',
+    'sphinx.ext.coverage'
+]
+
+templates_path = ['_templates']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+language = 'ru'
+todo_include_todos = True
+add_module_names = False
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'alabaster'
+html_static_path = ['_static']

docs/index.rst

@@ -0,0 +1,19 @@
+.. Kontur Focus Library documentation master file, created by
+   sphinx-quickstart on Mon Mar 10 17:54:03 2025.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Kontur Focus Library documentation
+==================================
+
+Add your content using ``reStructuredText`` syntax. See the
+`reStructuredText <https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html>`_
+documentation for details.
+
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   setup
+   usage

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/setup.rst

@@ -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``

docs/usage.rst

@@ -0,0 +1,46 @@
+=============
+Использование
+=============
+
+Подготовка
+----------
+
+Создайте файл `.env` или добавьте в существующий параметры:
+
+- `FOCUS_BASE_URL=<kontur_url>`
+- `FOCUS_ACCESS_KEY=<your_access_key>`
+
+Где `kontur_url` - адрес REST API Контур.Фокус. Например, `https://focus-api.kontur.ru/api3`.
+
+А `FOCUS_ACCESS_KEY` - секретный ключ доступа к REST API Контур.Фокус.
+
+Инициализация
+-------------
+
+.. code-block:: python
+
+    from kontur_focus import Focus
+
+    focus = Focus(inn='<inn_string>', ogrn='<ogrn_string>')
+
+Обязательный параметр - **ИНН**.
+
+
+Основные методы
+---------------
+
+Пример использования методов:
+
+.. code-block:: python
+
+    focus.base_info()
+
+.. autofunction:: kontur_focus.Focus.base_info()
+
+.. autofunction:: kontur_focus.Focus.advanced_info()
+
+.. autofunction:: kontur_focus.Focus.excerpt(path=None)
+
+.. autofunction:: kontur_focus.Focus.founders_history()
+
+.. autofunction:: kontur_focus.Focus.foreign_representatives()