Документация написана при помощи языка разметки reStructuredText и генератора Sphinx. Sphinx — это генератор документации, который преобразует файлы в формате reStructuredText в HTML website и другие форматы (PDF, EPub и man).
Установка
pip install -r requirements.txtКлонирование репозитария
git clone git@github.com:ustu/lectures.www.git
cd lectures.www.
├── docs <----- Лекции в формате RST
├── sourcecode <----- Исходные коды к лекциям
├── vagrant-data <----- Docker контейнер для запуска примеров
├── buildhtml.sh
├── make.bat
├── Makefile
├── README.rst
├── requirements.txt
├── rstlint.py
├── RULES.rst
├── test.sh <----- Всякие линтеры и чекеры
└── Vagrantfile <----- Vagrant для автоматизации запуска Docker контейнеровДля Unix like
make htmlДля Windows
make.bat htmlДля команды make livehtml необходимо установить sphinx-autobuild
Смотри CONTRIBUTING.rst
