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

Question

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

Answer 1

Для пакетов узлов пока нет автоматического разрешения. Вы можете вручную указать каждый зависимый пакет в команде 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, чтобы собрать все эти .cmis.

Answer 2

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

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