Заготовка документации

.gitignore

@@ -14,3 +14,5 @@
 /Yandex.Music.Api.Tests/bin
 /Yandex.Music.Client.Tests/bin/Debug
 /Yandex.Music.Client/bin/Debug
+/docs/build
+/.vscode

docs/source/api/api.rst

@@ -0,0 +1,11 @@
+.. yandex-music-api documentation master file, created by
+   sphinx-quickstart on Tue Jun  4 13:45:53 2019.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Yandex.Music.API
+==================================================================
+
+.. toctree::
+
+   ../common/common

docs/source/client/client.rst

@@ -0,0 +1,11 @@
+.. yandex-music-api documentation master file, created by
+   sphinx-quickstart on Tue Jun  4 13:45:53 2019.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Yandex.Music.Client
+==================================================================
+
+.. toctree::
+
+   ../common/common

docs/source/common/common.rst

@@ -0,0 +1,54 @@
+.. yandex-music-api documentation master file, created by
+   sphinx-quickstart on Tue Jun  4 13:45:53 2019.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Сборка и тестирование
+==================================================================
+
+==================================================================
+Сборка
+==================================================================
+
+Проекты нацелены на .Net Core 3.1. Сборка вне Visual Studio 2019 производится 
+стандартной командой
+
+.. code-block:: shell
+
+   dotnet build
+
+==================================================================
+Тестирование
+==================================================================
+
+В решение добавлен проект с тестами. Для тестов используется фреймворк
+xUnit с расширениями FluentAssertions и Xunit.Extensions.Ordering. Т.к. 
+при тестировании используются зависимые данные, все тесты запускаются 
+последовательно и учитывают результат предыдущих необходимых операций.
+
+Для тестирования необходимо добавить в директорию сборки файл appSettings.json 
+со следующим содержимым:
+
+.. code-block:: json
+
+   {
+      "login": "",
+      "password": "",
+      "token": ""
+   }
+
+Поля объекта соответственно указывают на логин, пароль и токен для доступа к 
+Яндекс.Музыка. При отсутствии токена будет произведена авторизация и получение 
+токена. Для работы с библиотекой рекомендуется использовать способ доступа именно
+через токен.
+
+Вне Visual Studio 2019 запуск тестов производится стандартной командой
+
+.. code-block:: shell
+
+   dotnet test
+
+В результате теста в выходной директории будет создана папка responses, в 
+которой в случае проблем с десериализацией ответов будут сохранены копии ответа, 
+а также создан файл с логом, содержащий описание проблемы. Их можно прикладывать 
+к `issues <https://github.com/K1llMan/Yandex.Music.Api/issues>`_.

docs/source/conf.py

@@ -19,8 +19,8 @@
 # -- Project information -----------------------------------------------------
 
 project = 'Yandex Music API'
-copyright = '2019, Winster332'
-author = 'Stanislav Vladimirovich Martynov'
+copyright = '2020, K1llM@n'
+author = 'K1llM@n, based on Winster332 project'
 
 language = 'ru'
 

docs/source/index.rst

@@ -1,12 +1,7 @@
-.. yandex-music-api documentation master file, created by
-   sphinx-quickstart on Tue Jun  4 13:45:53 2019.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
-Документация неофициальной C# библиотеки для API Yandex Music
+Документация неофициальной C# библиотеки для API и клиента Yandex Music
 ==================================================================
 
 .. toctree::
 
-   readme
-   yandex_music
+   api/api
+   client/client