Генерация документации для проекта BuckleScript

Есть ли способ создать документацию по коду для BuckleScript или Reason? Я пробовал использовать ocamldoc, но не знаю, как автоматически включать зависимости пакетов узла.


ocaml reason bucklescript
person henoc    schedule 25.11.2017    source источник

Ответы (2)


arrow_upward
3
arrow_downward

Для узловых пакетов пока нет автоматического разрешения. Вы можете вручную указать каждый зависимый пакет в команде ocamldoc, например:

ocamldoc -html -d doc -I node_modules/bs-webapi/lib/ocaml -I node_modules/bs-fetch/lib/ocaml -I node_modules/bs-platform/lib/ocaml src/YourModule.re

Включаемые каталоги довольно предсказуемы, вам просто нужно указать lib/ocaml каталогов в каждом пакете, ocamldoc найдет их скомпилированные .cmi файлы и извлечет оттуда информацию о требуемом типе.

Это также означает, что вам сначала нужно будет выполнить bsb -make-world, чтобы скомпилировать все эти .cmi.

person Yawar    schedule 25.11.2017

arrow_upward
0
arrow_downward

Существует инструмент, который предположительно автоматически выполняет большую часть оркестровки ocamldoc, описанной @Yawar, под названием BsDoc.

Обратите внимание, что я не использовал это сам; но предполагалось, что он подойдет для многих проектов, специфичных для BuckleScript (т. е. использование bsb с npm установленными зависимостями, а не dune с opam установленными зависимостями).

person ELLIOTTCABLE    schedule 19.01.2020