ElyBy-Mirror/docs
1
0
Fork 0
mirror of https://github.com/elyby/docs.git synced 2024-12-23 05:29:57 +05:30
Code Issues Packages Projects Releases Wiki Activity
Ely.by documentation site
22 Commits 2 Branches 0 Tags 3.5 MiB
Python 50.3%
Makefile 23.2%
Batchfile 22.3%
CSS 2.7%
HTML 1.5%
381b7a3051
Go to file
ErickSkrauch 381b7a3051
English translation of skins system article (#2) 
* Added English translation of skins system article

* Apply suggestions from code review

Co-Authored-By: erickskrauch <erickskrauch@ely.by>

* Update English skins system article according to the Russian article

* Apply review recommendations
2019-05-04 19:19:37 +03:00
source English translation of skins system article (#2) 2019-05-04 19:19:37 +03:00
_config.yml Improve static files copier 2019-02-22 23:13:02 +03:00
.gitignore Изменения, направленные на лучший опыт разработки: 2015-08-23 20:03:58 +03:00
.travis.yml Add cache for the pip dependencies 2019-02-22 18:21:11 +03:00
CNAME Create CNAME 2019-02-21 03:14:12 +03:00
make.bat Ещё чуть-чуть доработаны make файлы 2015-08-28 22:38:50 +03:00
Makefile Ещё чуть-чуть доработаны make файлы 2015-08-28 22:38:50 +03:00
README.md Обновлена документация по серверу авторизации 2015-08-23 20:25:18 +03:00
requirements.txt Изменения, направленные на лучший опыт разработки: 2015-08-23 20:03:58 +03:00

README.md

Документация 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 убедитесь, что в пути нет русских, белорусских, китайских или иных других символов, отличных от англисйкого алфавита.