HTTPS SSH

О проекте

Проект предназначен для начинающих веб-разработчиков платформы CS-Cart.

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

Последняя стабильная сборка расположена по адресу docs.cs-cart.ru.

Как собрать документацию

Документация написана на reStructuredText с использованием sphinx-doc.

Установка Python на Windows

Большинство пользователей Windows не имеют в системе установленного интерпретатора языка Python, поэтому для начала работы с проектом вам потребуется его установить. В противном случае, пожалуйста, пропустите этот шаг. Перейдите по адресу http://python.org на главную страницу проекта. В левой колонке перейдите по ссылке "Windows Installer" для загрузки Python. Разработчики поддерживают две мажорные версии своего интерпретатора — 2.x и 3.x, мы рекомендуем установить Python 2.7.

После установки внесите изменения в переменные окружения PATH, чтобы иметь возможность запускать команды интерпретатора из командной строки Windows. Нажмите ПКМ на иконку "Мой компьютер" и выберите меню "Свойства", нажмите на "Переменные среды" во вкладке "Дополнительно", после чего в переменной PATH укажите два каталога — C:\Python27 и C:\Python27\Scripts. Обратите внимание, что каталоги отделяются друг от друга символом ";".

Установка setuptools на Windows

Библиотека setuptools позволяет автоматически загружать, собирать, устанавливать и управлять пакетами языка Python – он нам пригодится для утилиты easy_install, чтобы легко и безболезненно установить pip. Для установки загрузите файл сценария ez_setup.py на свой компьютер и разместите его в корне локального диска C. Затем откройте командную строку Windows и выполните следующую команду для установки setuptools:

$ C:> python ez_setup.py

Установка pip на Windows

pip представляет собой систему управления пакетами Python, большая часть их может быть найдена в PyPI (Python Package Index), включая необходимые зависимости для работы сборщика документации Sphinx-Doc. Для установки pip загрузите файл сценария get-pip.py на свой компьютер а разместите его в корне локального диска C. После загрузки, запустите командную строку Windows и выполните следующую команду:

$ C:> python get-pip.py

Установка Git на Windows

Git необходим для работы с репозиторием проекта, установить его в Windows очень просто. У проекта msysGit процедура установки — одна из самых простых. Просто скачайте exe-файл инсталлятора со страницы проекта и запустите его. После установки у вас будет как консольная версия, включающая SSH-клиент, так и стандартная графическая.

Используйте Git только из командой оболочки, входящей в состав msysGit, потому что так вы сможете запускать сложные команды, входящие в состав инструкции. Командная оболочка Windows использует иной синтаксис, из-за чего некоторые команды в ней могут работать некорректно.

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

Склонируйте репозиторий, переключитесь в каталог сборки и установите необходимые зависимости:

$ git clone https://bitbucket.org/cs-cart/docs.cs-cart.ru.git

$ cd docs.cs-cart.ru/

$ pip install -r requirements.txt

Готово. Теперь вы можете собирать документацию командой sphinx-build -aE . _build/html, результат сборки появится в каталоге _build/html.

Контрибьютинг — совместная разработка

Мы принимаем пул-реквесты и любые замечания в разделе Issues — нам пригодится любая помощь в написании статей и выявлении ошибок.