You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Describe the bug
The documentation says that providing --enable-documentation command line flag and having documentation: true in cabal.project should have the same effect (minus tests/bench targets):
However, when I add documentation: true to my cabal.project file I get this result:
and with --enable-documentation flag get this result:
Note that with documentation: true field no links are generated for externally defined types except if they are defined in base.
It is either a bug in propagating flags or the feature is not documented clearly/correctly.
To Reproduce
Get a library that has dependencies from Hackage (not base)
Add documentation: true to cabal.project
Build the library: cabal v2-build all
Open generated documentation
Observe missing links
Build again with cabal v2-build all --enable-documentation
Observe that externally defined types are hyperlinked
Expected behavior
In both cases I would expect externally defined types to be hyperlinked.
Alternatively (if it is a documentation bug) I would expect the documentation to mention extra parameters to be added to cabal.project in order to have externally defined types hyperlinked.
System information
Linux, MacOS
cabal-3.0.0.0, ghc-8.6.5, haddock-2.22.0
The text was updated successfully, but these errors were encountered:
Haven't had time to dig into the code too much but it appears that this may be due to a misconfigured (or missing) --read-interface param passed to Haddock (see docs) when invoked from the project context. Haddock is invoked in Cabal here, would need to trace through to figure out how the options get passed to regenerateHaddockIndex when the documentation flag comes from the project config.
Describe the bug
The documentation says that providing
--enable-documentation
command line flag and havingdocumentation: true
incabal.project
should have the same effect (minus tests/bench targets):However, when I add

documentation: true
to mycabal.project
file I get this result:and with

--enable-documentation
flag get this result:Note that with
documentation: true
field no links are generated for externally defined types except if they are defined inbase
.It is either a bug in propagating flags or the feature is not documented clearly/correctly.
To Reproduce
base
)documentation: true
tocabal.project
cabal v2-build all
cabal v2-build all --enable-documentation
Expected behavior
In both cases I would expect externally defined types to be hyperlinked.
Alternatively (if it is a documentation bug) I would expect the documentation to mention extra parameters to be added to
cabal.project
in order to have externally defined types hyperlinked.System information
cabal-3.0.0.0
,ghc-8.6.5
,haddock-2.22.0
The text was updated successfully, but these errors were encountered: