mirror of
https://github.com/SantaSpeen/anixart.git
synced 2026-06-25 05:51:25 +00:00
Создана структура документации
This commit is contained in:
@@ -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: .
|
||||||
@@ -1,5 +1,10 @@
|
|||||||
# anixart
|
# Anixart API wrapper
|
||||||
Wrapper for using the Anixart API.
|
## Описание
|
||||||
|
|
||||||
|
Враппер для использования Anixart API.\
|
||||||
|
Библиотека создана только для ознакомления c API.
|
||||||
|
|
||||||
|
**Автор презирает и не поддерживает создание авторегов / ботов для накрутки / спам ботов.**
|
||||||
|
|
||||||
## License
|
## License
|
||||||
```text
|
```text
|
||||||
|
|||||||
@@ -0,0 +1,16 @@
|
|||||||
|
# CHANGELOG
|
||||||
|
|
||||||
|
## Anixart API Wrapper
|
||||||
|
|
||||||
|
### 27.09.2022
|
||||||
|
#### Version: 0.1, Build: 1
|
||||||
|
|
||||||
|
##### Changes:
|
||||||
|
|
||||||
|
* Создана общая структура библиотеки
|
||||||
|
* Создана структура документации
|
||||||
|
* Добавлена лицензия
|
||||||
|
|
||||||
|
##### TODOs:
|
||||||
|
|
||||||
|
* Пока не запланировано
|
||||||
@@ -0,0 +1,24 @@
|
|||||||
|
---
|
||||||
|
hide:
|
||||||
|
- toc
|
||||||
|
---
|
||||||
|
# Anixart API wrapper
|
||||||
|
## Описание
|
||||||
|
|
||||||
|
Враппер для использования anixart API.\
|
||||||
|
Библиотека создана лишь для ознакомления.
|
||||||
|
|
||||||
|
**Автор презирает и не поддерживает создание авторегов / ботов для накрутки / спам ботов.**
|
||||||
|
|
||||||
|
## Оглавление:
|
||||||
|
|
||||||
|
1. Общая информация:
|
||||||
|
* 1
|
||||||
|
* 2
|
||||||
|
* ...
|
||||||
|
2. API
|
||||||
|
* 1
|
||||||
|
* 2
|
||||||
|
* ...
|
||||||
|
3. [CHANGELOG](/CHANGELOG)
|
||||||
|
4. [License](/License)
|
||||||
@@ -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
|
||||||
Reference in New Issue
Block a user