问题标签 [haddock]
For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.
haskell - 如何为所有包自定义 Haddock 文档生成？
我不清楚如何自定义
生成。例如，我如何包含源链接，或使用自定义 CSS 文件以便它们适用于所有情况？
在我~/.cabal/config尝试过
但我不清楚这些设置的范围是什么。
如何为 Haddock 生成的所有文档自定义默认文档生成：我构建cabal haddock的包，我从 Hackage 安装的包cabal install，甚至是我上传到 Hackage 的包cabal sdist？
haskell - 黑线鳕的差异文档
如果我cabal build在我的库上做 a ，然后更改一个文件，下次我运行时cabal build，我只需要重新编译受更改影响的文件。我没有得到与cabal haddock命令相同的行为：当我在更改文件后运行它时，cabal/haddock 最终会丢弃所有以前的工作并从头开始。这相当耗时；有没有办法对文档进行差异更新？
这是生成文档的命令 cabal 问题的转储。
haskell - 使用 Haddock 和 stack 为我自己的代码生成文档
我已经用 Haddock 样式注释了我的代码，并希望生成可浏览的文档。由于我也在使用堆栈，因此我想将文档生成集成到工作流程中。但是，我还不能生成任何有用的东西。
我可以跑
它会以我想要的样式生成文档（可以在里面找到~/.stack/），但它似乎只为我所依赖的包生成文档，而不是为我自己的代码生成文档。
当我跑
我得到的印象是我可以使用附加参数--haddock为我自己的项目生成文档，并--no-haddock-deps为我的依赖项省去文档。但是，当我跑步时
似乎什么都没有发生。如果我stack clean首先它会重新编译我的所有代码，但没有生成似乎与文档有任何关系的输出。
作为中间解决方案，我也尝试过自己运行 Haddock，即
但后来我收到一个错误，它找不到文件所依赖的模块（由堆栈在本地安装）。这给我的印象是文档生成必须以某种方式通过堆栈。我一直在寻找，但没有真正找到任何与配置我的文件.cabal和stack.yaml文件相关的解释。
TL;博士
如何使用 stack 和 Haddock 为我自己的包中的代码生成文档？
css - 如何在我的 Haddock 文档中获得“样式”菜单？
一些包（Haddock 文档，例如Data.String.Utils）有一个菜单栏，其中包括一个“样式”菜单，允许在用于显示文档的样式中进行选择：
如何在我自己的包的文档中获取此菜单？我应该使用什么设置来包含它，以及如何指定提供哪些样式？
我试过像
和
在我的~/.cabal/config; 但前者失败，后者仅使用最后列出的css条目进行格式化，没有“样式”菜单。
haskell - Should I use 'let' in my REPL Haddock examples?
What is the correct idiom for assignments in Haddock REPL examples? Specifically, should I use let
(as is — still — expected by GHCi) or omit it
(as I can in IHaskell)?
haskell - 如何将我的 Haskell 包的文档获取到 Hackage 上？
更新：这个问题现在已经过时了。Hackage 现在使用 Haskell 版本 7.10.2 构建，所以不会出现以下故障。这一变化似乎也破坏了答案中提到的一些脚本。
如何将我的 Haskell 包的文档获取到 Hackage 上？
我了解 Hackage 将构建它们的内容，但出现错误
我无法降低我的包的要求（这似乎是自动构建的障碍），我看到一些包说“用户上传的文档”。但是，任何构建尝试都会失败（见下文。）
如何将我的 Haskell 包的文档获取到 Hackage 上？特别是，我需要做什么才能自己上传它们？
我试过了
但得到
无效的文档 tarball：tar 存档中的文件不在预期的目录“MyPackage-0.1.0.2-docs”中
我也尝试了下面链接的几个脚本的我自己的版本，但得到了同样的错误：
我用它调用
但得到同样的错误。
haskell - Hackage 文档构建队列是否可见？
将新版本的 Haskell 包上传到 Hackage 后，自动文档构建可能需要一些时间，因为该包缺少在线文档。在构建此类文档之前，我不希望宣布包更改。
有没有一种方法可以查看 Hackkage 文档构建队列，或者是否有另一种方法可以估计构建我的文档需要多长时间；或者甚至是一种安排通知的方式？
请注意，这不是关于如何手动上传文档的问题。我知道该怎么做（并且不想这样做）。
haskell - 更改重新导出的类型和值的文档
假设我有一个从内部模块重新导出值的模块：
我想为SomeTypeand展示不同someValue的文档My-Cool-Module.html，My-Cool-Module-Internal.html因此前者可以讨论公共 API，而后者可以讨论它们与其他内部结构的关系。
有没有办法用黑线鳕做到这一点？
我试过了：
但是黑线鳕给了我一个解析错误：
haskell - 为什么 cabal haddock --hyperlink-source 不生成源 HTML？
对于一个 cabal 项目，我想生成带有源代码超链接的黑线鳕文档，所以我照常进行：
生成了链接，但是单击链接后，我发现即使链接包含实际源代码也不包括在内。源代码应该通过 HTML 呈现。我如何也生成这些？
目前使用：
- 阴谋集团 1.22.4.0
- 阴谋安装 1.22.6.0
- 黑线鳕 2.16.1