README.rst

Инструкция как писать эту документацию

Документация написана при помощи языка разметки reStructuredText и генератора Sphinx. Sphinx — это генератор документации, который преобразует файлы в формате reStructuredText в HTML website и другие форматы (PDF, EPub и man).

• https://ru.wikipedia.org/wiki/Sphinx_(генератор_документации)
• Документация на русском

Установка

Клонирование репозитария

$ git clone [email protected]:ustu/lectures.www.git
$ cd lectures.www

Инициализация подмодулей (сами лекции)

$ git submodule update --init --recursive --remote

Установка

$ pip install -r _lectures/requirements.txt

или через nix:

$ cd _lectures
$ nix-shell

Структура

.
├── docs             <----- Файлы настроек для лекций в формате RST
├── vagrant          <----- Docker контейнер для запуска примеров
├── make.bat
├── Makefile
├── README.rst
├── requirements.txt
├── rstlint.py
├── CONTRIBUTING.rst
├── test.sh          <----- Всякие линтеры и чекеры
└── Vagrantfile      <----- Vagrant для автоматизации запуска
                            Docker контейнеров

Сборка

Для Unix like

$ LECTURES=www make html

В Docker

$ LECTURES=www vagrant up --provider=docker

$ LECTURES=www vagrant reload

Требования к оформлению

Смотри CONTRIBUTING.rst