Dev:RU/Doc/Tools/User Reference Manual/Editor Vim/InstantRST

Это краткое руководство о том, как я редактирую blender-manual с откликом в реальном времени (WYSIWYG).

Это руководство опирается на vim и систему Instant-rst от Rykka

Установка

1. Перейдите на страницу документации и проследуйте инструкциям по её сборке: [ссылка]

(в данном руководстве я подразумеваю, что исходные коды лежат в ~/blender-manual)

2. Установите InstantRst: [ссылка] (плагин для vim)

3. Установите сервер InstantRst: [ссылка] (это подправленный плагин на python)

Запуск сервера

instantRst -f ~/blender-manual/manual/render/workflows/bake.rst -i ~/blender-manual/manual/images

Редактирование руководства

vim ~/blender-manual/manual/render/workflows/bake.rst

Теперь файл открыт в vim и вы можете запустить плагин

:InstantRst

Начните редактировать файл и смотрите, как ваш браузер обновляет содержимое по мере того, как вы его правите.

Дальнейшие соображения

Некоторый синтаксис RST не поддерживаются сервером Instanst-Rst (в частности, роль guilabel, которую мы часто используем). Так что хорошо бы собрать документацию по-нормальному, чтобы убедиться, что всё выглядит хорошо. В этом случае вы должны выполнить либо make, чтобы собрать вообще всё, либо make render для сборки только той части, что относится к визуализации (поскольку мы правили файл из этого раздела).

Дополнительные замечания

Правленный сервер instant-rst имеет две новых возможности:

• Новый параметр командной строки для указания папки с изображениями
• Статические файлы и шаблоны, необходимые для руководства по Blender

В будущем мы попытаемся изменить эту систему, чтобы её можно было влить обратно в основную ветку.