Переведено Basster284
Это исходный код документации Geode, содержащий все туториалы.
Класс & функция документации автоматически собраны из исходного кода Geode.
Сборка документации работает через Flash. Чтобы собрать документацию, вам нужен Flash вместе с CMake и Clang.
Чтобы собрать документацию, сперва вам нужно клонировать Geode, а затем клонировать документацию внутри корневой папки Geode, структура папок должна выглядеть так:
geode/
docs/
<docs files>
<geode files>
Как вариант, вы сможете создать папки таким образом:
git clone https://github.com/geode-sdk/geode
cd geode
git clone https://github.com/geode-sdk/docs
Альтернативным методом, вы можете создать символическую ссылку с вашей локальной копии папки с документацией в вашу локальную копию папки Geode.
После сборки Flash из исходного кода через Cargo или устанавливая последний релиз, вы можете собрать документацию следующей командой:
flash -i <путь/к/geode> -o <относительная_выходная_директория> --overwrite
После этого, запустите локальный HTTP сервер в директории где вы запускаете Flash.
Вы должны запустить Flash в папке, в который вы хотите собрать документацию и использовать параметр -o ., илм же запустить в папке выше и прописать -o <имя_выходной_папки>.