如何使用haddock生成文档？

Question

我正在使用的项目没有关于Stackage的文档（它们已经过时了）。这是原始的0.3版本。

https://hackage.haskell.org/package/reflex-dom-0.3/docs/Reflex-Dom-Widget-Basic.html

我被告知我可以使用黑线鳕生成文档。我的计算机上有源代码（使用 DateTimeFormatter formatter = new DateTimeFormatterBuilder() .appendLocalized(null, FormatStyle.SHORT) .toFormatter(Locale.ITALY); LocalTime time = LocalTime.from(formatter.parse("10.45")); long minutes = Duration.between(LocalTime.MIN, time).toMinutes(); ）版本0.4

haddock网页过于先进。

对于初学者，一旦我进入我的目录，我该如何生成文档？

感谢我提出的答案之一，但这是一条错误消息：

git clone

Answer 1

安装haddock后，您可以按以下方式运行它：

haddock --html -o <haddock-folder> <list-of-haskell-files>

例如：

haddock --html -o the_documentation *.hs

将生成名为the_documentation的目录中该目录（不是任何子目录）中所有Haskell文件的文档。

有些shell允许**.hs查找所有 .hs个文件（包含子目录）。所以你可以试试：

haddock --html -o the_documentation **.hs

如果shell没有支持，您当然可以使用find和xargs的组合，例如：

find -iname '*.hs' | xargs haddock --html -o the_documentation

此处find将生成以.hs结尾的所有文件的列表，xargs会将所有这些文件作为参数写入haddock --html ...。

Answer 2

cabal haddock或stack haddock。