如何在Haddock文档中生成表

Question

我正在用Haddock编写一些文档，我需要在其中放入一个包含一些值的多列表。我怎么能用Haddock做到这一点？我找不到有关它的信息。嵌入一​​些html作为替代看起来也不可能。

Answer 1

与GHC 8.4或更新版本捆绑的Haddock（Haddock版本＆gt; = 2.18.2）支持表格。根据{{​​3}}，语法基于the pull request where this was added。

样品使用：

module Sample where

-- | A table:
--
-- +------------------------+------------+----------+----------+
-- | Header row, column 1   | Header 2   | Header 3 | Header 4 |
-- | (header rows optional) |            |          |          |
-- +========================+============+==========+==========+
-- | body row 1, column 1   | column 2   | column 3 | column 4 |
-- +------------------------+------------+----------+----------+
-- | body row 2             | Cells may span columns.          |
-- +------------------------+------------+---------------------+
-- | body row 3             | Cells may  | \[                  |
-- +------------------------+ span rows. | f(n) = \sum_{i=1}   |
-- | body row 4             |            | \]                  |
-- +------------------------+------------+---------------------+
sample :: ()
sample = ()

变成

RST Grid tables

Answer 2

Haddock "markup"目前不支持表格，另请参阅Haddock User Guide - Chapter 3. Documentation and Markup。有一个open issue可以添加对简单表的支持。