diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..cec592a --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,16 @@ +version: 2 + +build: + os: ubuntu-20.04 + tools: + python: "3.9" + +mkdocs: + configuration: ./docs/mkdocs.yml + fail_on_warning: false + +python: + install: + - requirements: requirements.txt + - method: pip + path: . \ No newline at end of file diff --git a/README.md b/README.md index 4e9d23d..14d4fcd 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,10 @@ -# anixart -Wrapper for using the Anixart API. +# Anixart API wrapper +## Описание + +Враппер для использования Anixart API.\ +Библиотека создана только для ознакомления c API. + +**Автор презирает и не поддерживает создание авторегов / ботов для накрутки / спам ботов.** ## License ```text @@ -9,4 +14,4 @@ Permission is hereby granted, free of charge, to any person obtaining a copy of Permission is granted to sell and/ or distribute copies of the Software in a commercial context, subject to the following conditions: - Substantial changes: adding, removing, or modifying large parts, shall be developed in the Software. Reorganizing logic in the software does not warrant a substantial change. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -``` \ No newline at end of file +``` diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md new file mode 100644 index 0000000..72677c7 --- /dev/null +++ b/docs/CHANGELOG.md @@ -0,0 +1,16 @@ +# CHANGELOG + +## Anixart API Wrapper + +### 27.09.2022 +#### Version: 0.1, Build: 1 + +##### Changes: + +* Создана общая структура библиотеки +* Создана структура документации +* Добавлена лицензия + +##### TODOs: + +* Пока не запланировано diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..c20827f --- /dev/null +++ b/docs/index.md @@ -0,0 +1,24 @@ +--- +hide: + - toc +--- +# Anixart API wrapper +## Описание + +Враппер для использования anixart API.\ +Библиотека создана лишь для ознакомления. + +**Автор презирает и не поддерживает создание авторегов / ботов для накрутки / спам ботов.** + +## Оглавление: + +1. Общая информация: + * 1 + * 2 + * ... +2. API + * 1 + * 2 + * ... +3. [CHANGELOG](/CHANGELOG) +4. [License](/License) \ No newline at end of file diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml new file mode 100644 index 0000000..35a21fe --- /dev/null +++ b/docs/mkdocs.yml @@ -0,0 +1,48 @@ +site_name: anixart +repo_url: https://github.com/SantaSpeen/anixart +site_author: Maxim Khomutov +remote_name: master +use_directory_urls: true + +nav: + - Введение: index.md + - Общая информация: + Быстрое начало: home/index.md + Примеры использования: home/examples.md + - API библиотеки: + Введение: LibApi/index.md + Метки и условные обозначения: LibApi/tags.md + Методы: LibApi/methods.md + Неописанные методы: LibApi/todo_methods.md + - API Anixart: + Введение: anixApi/index.md + Auth: anixApi/auth.md + Profile: anixApi/profile.md + Collections: anixApi/collections.md + Release: anixApi/release.md + Other: anixApi/other.md + + - CHANGELOG: CHANGELOG.md + - Обратная связь: callback.md + +theme: + name: material + locale: ru + highlightjs: true + palette: + - scheme: default + toggle: + icon: material/weather-sunny + name: Включить ночную тему. + - scheme: slate + toggle: + icon: material/weather-night + name: Включить дневную тему. + +markdown_extensions: + - pymdownx.highlight: + anchor_linenums: true + - pymdownx.inlinehilite + - pymdownx.snippets + - pymdownx.superfences + - tables