Ely.by documentation site
Go to file
GGSkyOne ce5cf5c6f6
Suggest community Node.js library for Ely.by API (#21)
* Suggest my npm library

Suggest my npm library as an unofficial library for ely.by for node.js

* Fix link

---------

Co-authored-by: ErickSkrauch <erickskrauch@yandex.ru>
2024-08-14 17:14:41 +02:00
.github/workflows Add stupid v prefix 🙃 2024-01-24 02:38:52 +01:00
source Suggest community Node.js library for Ely.by API (#21) 2024-08-14 17:14:41 +02:00
.gitignore Completely upgrade project: 2021-03-20 03:27:22 +01:00
.nojekyll Completely upgrade project: 2021-03-20 03:27:22 +01:00
build-multilang.py Completely upgrade project: 2021-03-20 03:27:22 +01:00
CNAME Create CNAME 2019-02-21 03:14:12 +03:00
crowdin.yml Completely upgrade project: 2021-03-20 03:27:22 +01:00
make.bat Ещё чуть-чуть доработаны make файлы 2015-08-28 22:38:50 +03:00
Makefile Ещё чуть-чуть доработаны make файлы 2015-08-28 22:38:50 +03:00
Pipfile Completely upgrade project: 2021-03-20 03:27:22 +01:00
Pipfile.lock Bump lxml from 4.6.2 to 4.6.3 (#11) 2021-03-23 15:07:19 +01:00
README.md Обновлена документация по серверу авторизации 2015-08-23 20:25:18 +03:00

Документация Ely.by

В этом репозитории находятся исходные файлы сайта документации проекта Ely.by

В этой документации вы найдёте информацию о публичных сервисах проекта Ely.by, ознакомившись с которой вы сможете самостоятельно реализовать свои программные продукты для совместной работы с сервисом Ely.by.

Вы можете свободно улучшать и вносить предложения по изменениям в документацию.

Установка зависимостей

Для ведения документации мы используем генератор документации Sphinx и тему Read the Docs Sphinx Theme с небольшими доработками под стиль сайта.

Для компиляции вам понадобится установленный Python 2.7 (теоретически будет работать и на 3.4, но мы не проверяли) и менеджер зависимостей pip. Убедитесь, что они доступны глобально.

Для начала форкните и склонируйте этот репозиторий к себе на компьютер. За тем установите зависимости. Для этого, находясь в папке проекта, откройте консоль и выполните:

pip install -r requirements.txt

Компиляция и разработка

После установки необходимых зависимостей вам необходимо запустить непосредственно процесс компиляции. Вы можете вручную настроить свой веб-сервер для работы со скомпилированными шаблонами, скомпилировав их командой make html или же воспользуйтесь командой make livehtml для запуска локальное веб-сервера и автоматической рекомпиляции шаблонов, при их изменении. Сайт станет доступен по адресу 127.0.0.1:8000.

Примечание

На операционных системах Windows Python не очень любит неанглийские символы в пути к файлам, так что при разработке под Windows убедитесь, что в пути нет русских, белорусских, китайских или иных других символов, отличных от англисйкого алфавита.