标签: haddock

为什么Cabal没有超链接我的来源?

$ cabal --version
cabal-install version 1.22.2.0
using version 1.22.2.0 of the Cabal library 


$ cabal install --haddock-hyperlink-source gloss-juicy
Warning: /home/theking/.cabal/config: Unrecognized field hyperlink-source on
line 91
Run Code Online (Sandbox Code Playgroud)

我确实hyperlink-source: True在我的配置中.我添加了标志只是为了多余.当我查找文档时,它都是彩色的和一切,但源代码没有链接.我究竟做错了什么?

haskell hyperlink cabal haddock

4
推荐指数
1
解决办法
81
查看次数

为什么cabal haddock -hyperlink-source不生成源HTML?

对于cabal项目,我想生成带有源代码超链接的haddock文档,所以我按照惯例做了:

cabal haddock --hyperlink-source
Run Code Online (Sandbox Code Playgroud)

链接已生成,但点击链接后,我发现即使链接也没有包含实际的源代码.源代码应该通过HTML呈现.我如何生成这些?


目前使用:

  • Cabal 1.22.4.0
  • cabal-install 1.22.6.0
  • 黑线鳕2.16.1

haskell hyperlink cabal haddock

4
推荐指数
1
解决办法
242
查看次数

是否可以使用 Haddock 拥有仅文档文件?

我正在为 Haskell 模块编写文档,其中包含大量测试和示例。这使我的源文件很长(3000 行)。

我的想法是用我的完整示例和文档(没有函数定义)制作第二个源文件 (*.hs)。但是当我编写文档时,我的标题无法正确显示:

module JeanJouX.Numeric.Tests (
    -- | Introduction to my module
    --
    -- * Section 1
    -- ** Sub section 1
    -- doc text
    -- ...
    -- * Section 2
    -- ** Sub section 1
    -- 
Run Code Online (Sandbox Code Playgroud)

但是当我像这样打破我的来源时:

module JeanJouX.Numeric.Tests (
    -- | Introduction to my module
    --

    -- * Section 1
    -- ** Sub section 1
    -- doc text
    -- ...
    -- * Section 2
    -- ** Sub section 1
    -- 
Run Code Online (Sandbox Code Playgroud)

我的文档文本没有出现(我认为 Haddock 正在等待函数导出)。

是否可以仅以 …

documentation haskell haddock

4
推荐指数
1
解决办法
68
查看次数

{-# OPTIONS_HADDOCK hide #-} 对非导出模块有影响吗?

假设我有一个使用 Cabal 打包和构建的库,并且某些模块Internal不在我的 cabal 文件的Exposed-modules. 如果我指定一个编译指示,会有什么区别吗?

{-# OPTIONS_HADDOCK hide #-}
Run Code Online (Sandbox Code Playgroud)

位于 的顶部Internal.hs,或者根据 Haddock 的说法它已经自动隐藏了?

如果确实有影响,会产生什么影响?

haskell cabal haddock

3
推荐指数
1
解决办法
471
查看次数

为什么没有haddock生成文档?

我的Haskell文件(很确定这不是问题)基本上是:

import System.IO
...

-- | Every Word is a String
type Word = String

...

-- | Some documentation for Haddock to see
main :: IO ()
main = do
        ...
Run Code Online (Sandbox Code Playgroud)

我的Setup.hs:

import Distribution.Simple
main = defaultMain
Run Code Online (Sandbox Code Playgroud)

我的grade.cabal:

name:                grade
version:             0.1.0.0
...
build-type:          Simple
cabal-version:       >=1.8

executable grade
  main-is:             grade.hs
  -- other-modules:       
  build-depends:       base ==4.6.*, split ==0.2.*
  hs-source-dirs:      src
Run Code Online (Sandbox Code Playgroud)

当我跑步时,cabal haddock --executables我得到了

...
Haddock coverage:
Warning: Not found in environment: Main.main
  50% …
Run Code Online (Sandbox Code Playgroud)

documentation haskell haddock

3
推荐指数
1
解决办法
204
查看次数

'stack haddock' 把它生成的文档放在哪里?

stack haddock(或stack build --haddock)将其生成的文档放在哪里?

haddock haskell-stack

3
推荐指数
1
解决办法
699
查看次数

如何在 Haddock 文档中生成表格

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

haskell haddock

3
推荐指数
1
解决办法
256
查看次数

Haddock对进口实体发表评论

有没有办法将Haddock文档添加到导出它的模块中的实体,而不是声明它的模块?

我有一个隐藏的模块,它声明了十几种类型,然后是另一个模块,它只导出最终用户应该看到的部分.将文档放在公开的模块而不是隐藏的模块中是合乎逻辑的.但我无法弄清楚如何做到这一点......

haskell haddock

2
推荐指数
1
解决办法
147
查看次数

我应该在REPL Haddock示例中使用'let'吗?

Haddock REPL示例中赋值的正确习惯是什么?具体来说,我应该使用let

>>> let x = 5
>>> x + 2
7
Run Code Online (Sandbox Code Playgroud)

(按原样 - 仍由GHCi预期)或省略它

>>> x = 5
>>> x + 2
7
Run Code Online (Sandbox Code Playgroud)

(就像我在IHaskell一样)?

haskell haddock

2
推荐指数
1
解决办法
66
查看次数

如何用haddock生成文档?

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

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

有人告诉我可以用 haddock 生成文档。我的电脑上有源代码(使用git clone)版本0.4

黑线鳕网页太先进了。

对于初学者来说,一旦进入我的目录,如何生成文档?


感谢我取得的答案之一,取得了进展,但这里有一条错误消息:

src/Reflex/Dom/Xhr.hs:154:0:
     error: missing binary operator before token "("
     #if MIN_VERSION_aeson(1,0,0)
     ^
Run Code Online (Sandbox Code Playgroud)

documentation haskell haddock

1
推荐指数
1
解决办法
836
查看次数

使用cabal生成文档

我迷路了.我不知道如何使用cabal在本地生成docs.我想要的是cabal安装gtk3,它确实生成了文档.或者,如果这不起作用,我如何在本地生成文档?

我将它放入cabal的.config文件中: - documentation:True

但是没有好的结局,没有文件可以找到

我想这很简单,我根本就没有看到....

好的,在一些评论的帮助下,我得到了更多.无论如何cabal只是为我做本地安装作为用户,它给了我一个警告,不建议全局.在这里,我找到了https://wiki.haskell.org/Cabal-Install

我应该为全球安装等做什么,但如果我不使用它,我会得到关于全局不应该使用的警告,即使文档集也做文档:真的我没有获得haskell的更新平台文档.

所以我不应该使用cabal进行全局文件安装?

haskell cabal haddock

1
推荐指数
1
解决办法
295
查看次数

标签 统计

haddock ×11

haskell ×10

cabal ×4

documentation ×3

hyperlink ×2

haskell-stack ×1