docs/README.md

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

В этом репозитории находятся исходные файлы [сайта документации](http://docs.ely.by) проекта [Ely.by](http://ely.by)

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

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

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

Для ведения документации мы используем [генератор документации Sphinx](http://sphinx-doc.org/) и тему
[Read the Docs Sphinx Theme](https://github.com/snide/sphinx_rtd_theme) с небольшими доработками под стиль сайта.

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

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

```
pip install -r requirements.txt
```

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

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

# Примечание

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