Внесение изменений в текст документации

Чтобы внести изменения в текст документации у себя на компьютере, сначала откройте папку markdown и выберете нужный файл для форматирования. Вы можете открыть его в любом редакторе, но я рекомендую использовать Typora. После внесения изменений приступите к сборке html файлов документации.

Сборка документации под Ubuntu

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

Если у вас не установлен git, то выполните команду:

$ apt install git

Затем скачайте репозиторий:

$ git clone https://github.com/VizTower/viz-doc.git

Перейдите в папку viz-doc:

$ cd viz-doc

2 Установка sphinx:

Если у вас не установлен pip, выполните команду:

$ apt install python-pip

Затем установите Sphinx:

$ pip install sphinx

3 Генерация rst файлов:

Если у вас не установлен pandoc, то установите его на сайте.

Команда ниже преобразует файлы из формата Markdown в папке markdown в формат reStructuredText, используя pandoc:

$ ./generate-rst.sh

4 Генерация html файлов:

Следующая команда вызовет сборщик документации sphinx, который создаст статические html файлы:

$ make html

После выполнения предыдущей команды, перейдите в папку _build/html и откройте в браузере файл index.html