问题标签 [haddock]

我从 tarball 源代码编译并安装了 haddock-2.4.2。

在此处为代码添加一些简单的注释：

• https://dl.getdropbox.com/u/143480/doc/DualMap.hs

和运行黑线鳕

产量：

• https://dl.getdropbox.com/u/143480/doc/Data-DualMap.html

事情看起来不错。（请注意，此模块仅依赖于 GHC 附带的库，而不依赖于其他源模块。）

但是，当我尝试在带有“-- * test”的评论中添加部分（a la http://www.haskell.org/haddock/doc/html/ch03s04.html#id289234 ）时，我得到：

我不知道从哪里开始让它工作，因为这个错误消息只告诉我 Haddock.Interface.depanal 没有返回任何东西（根据黑线鳕源的 grep），但没有告诉我如何阻止依赖项分析失败。也许我需要更多命令行参数或对 GHC/base/containers 文档或一些黑线鳕配置文件中缺少的链接目标的引用？

搜索 Google 发现了大量与 hackage 包相同的 cabal 构建错误，但没有关于如何修复它们的信息。

如何添加部分（带星号）并让 Haddock 生成我的文档？我错过了什么（可能很简单）？

我正在使用 GHC 并通过 Cabal 安装了几个软件包。其中一个包的网站说“去看看黑线鳕文档”。该haddock命令似乎仅适用于源文件，并且似乎仅适用于具有构建文件cabal haddock的项目的顶级目录。.cabal有没有办法为一个模块说“给我看看黑线鳕”？

我渴望pydoc -p 12345启动一个 HTTP 服务器，根据您在本地安装的内容提供 Python 文档。

作为一种解决方法，我从下面提取了源 tarball~/.cabal并cabal configure; cabal haddock在源目录中运行，但这有点痛苦。

该命令cabal haddock有非常有用的 --hyperlink-source 选项。我希望在使用cabal install.

#517 票似乎就是这样：http ://hackage.haskell.org/trac/hackage/ticket/517

但是，也许可以通过 ~/.cabal/config 文件设置此标志？

如果没有，我如何在不安装当前强制性的 Cabal-1.9（由于 12 月的一个补丁）的情况下使用来自 #517 的补丁来获得工作 cabal-install 构建？

目前我只使用 Haddock，但在看到一些真正有趣的 Haskell 示例（例如this gist）后，我有兴趣在项目中尝试它。

我得到的问题是：

• 你写什么作为黑线鳕评论，你在文学部分写什么？

• 您如何将文学编程扩展到多个文件？谁能给我举一个例子，在一个包含多个模块的包中使用文学编程？您在较大的软件包中使用文学编程的经验是什么？

• 识字的 Haskell 的哪种口味（markdown、latex、...）是首选？

• 你为什么要使用识字的 Haskell 或普通的 Haskell 编程？您是否同时使用这两种风格进行编程，如果是，为什么？

• 你更喜欢块式（\begin{code}）还是鸟式（>）？为什么？

我有以下功能：

Haddock 采用上述内容并生成以下 HTML：

“阿尔法”怎么了？

如果我接到电话

在 .cabal 文件的文档部分（描述）中，我会收到错误消息

跑步时

但如果我摆脱了{，}一切正常。有什么方法可以逃脱{}，以便可以在描述中使用它们吗？

我有一个关于 Hackage 的包，其中包含黑线鳕生成的文档，但它没有出现在 Hackage 页面上。我能够成功上传所有内容，但没有显示文档。

我使用cabal haddock或使用Package > Build DocumentationLeksah IDE 生成文档。

当我去Package > Open DocLeksah 时，它找不到它，因为它正在寻找dist/doc/html/hspec/hspec/index.html但生成的文件位于dist/doc/html/hspec/index.html. 我认为 Hackage 也在同一个地方寻找。

我猜我的源文件不在预期的位置，但我不知道它们应该如何。

源代码和目录结构可以在https://github.com/trystan/hspec找到。

我是操作包的作者，其中包括示例代码。我希望这个示例代码被 hscolored 并与由 Haddock 生成的 API 文档一起安装。

我可能必须使用自定义的 Cabal 构建类型并为 Haddock 阶段创建一个用户挂钩。但是，我从来没有设法完成这项工作。因此，我的问题是：

如何在 Haddock 中包含完整模块作为示例代码？

您能否举一个 Cabal 用户钩子的示例，该钩子将 hscolor 应用于其他源代码文件example.hs并将结果与​​生成的 Haddock 文档连接起来？

考虑以下模块

目的是该模块FirstClassModule提供了一种记录类型Bar，其工作方式有点像一流的模块。然后，模块Example实例化模块并使用 RecordWildCards 扩展将名称带入范围并使其可导出。

当你在这个模块上运行 Haddock（2.8 版）时，它会干扰foo函数的类型签名并将它们包含在 API 文档中。现在，我的问题是：

有没有办法记录生成的名称foo,fuh等而不在模块中写下它们的类型签名Example？

我不想写类型签名，因为在这种情况下，因为它们是样板文件。如果我必须把它们写下来，这个模块就失去了存在的理由。

我想在本地使用 Hoogle，这样我就可以在我的一个项目上运行搜索查询。有一些文档 [ here ]，但我不知道如何让它工作。它说要运行 Haddock，但 haddock 没有给出任何输出，只会吐出下面复制的警告。我还没有projectname.cabal文件，所以我不能使用该runhaskell Setup haddock --hoogle命令。