Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

The index.html that are supposed to be produced by cabal haddock-project are not here. #8843

Closed
Kleidukos opened this issue Mar 13, 2023 · 2 comments · Fixed by #8919
Closed

The index.html that are supposed to be produced by cabal haddock-project are not here. #8843

Kleidukos opened this issue Mar 13, 2023 · 2 comments · Fixed by #8919
Assignees
@coot
Labels
cabal-install: cmd/haddock

Comments

@Kleidukos
Copy link
Member

Kleidukos commented Mar 13, 2023 •
edited
Loading

Describe the bug
The index.html that are supposed to be produced by cabal haddock-project are not here.

To Reproduce
Steps to reproduce the behavior:

$ git clone https://github.com/haskell-cryptography/libsodium-bindings && cd libsodium-bindings
$ cabal haddock-project
Warning: haddock-project command is experimental, it might break in the future
Resolving dependencies...
Build profile: -w ghc-9.4.4 -O1
[…]
Documentation created:
/tmp/libsodium-bindings/dist-newstyle/build/x86_64-linux/ghc-9.4.4/libsodium-bindings-0.0.1.0/doc/html/libsodium-bindings/index.html
Documentation created:
/tmp/libsodium-bindings/dist-newstyle/build/x86_64-linux/ghc-9.4.4/sel-0.0.1.0/doc/html/sel/index.html
Documentation created: haddocks/index.html
$ file haddocks/index.html
haddocks/index.html: cannot open `haddocks/index.html` (No such file or directory)
$ file /tmp/libsodium-bindings/dist-newstyle/build/x86_64-linux/ghc-9.4.4/sel-0.0.1.0/doc/html/sel/index.html
/tmp/libsodium-bindings/dist-newstyle/build/x86_64-linux/ghc-9.4.4/sel-0.0.1.0/doc/html/sel/index.html: cannot open `/tmp/libsodium-bindings/dist-newstyle/build/x86_64-linux/ghc-9.4.4/sel-0.0.1.0/doc/html/sel/index.html' (No such file or directory)
$ file /tmp/libsodium-bindings/dist-newstyle/build/x86_64-linux/ghc-9.4.4/libsodium-bindings-0.0.1.0/doc/html/libsodium-bindings/index.html
/tmp/libsodium-bindings/dist-newstyle/build/x86_64-linux/ghc-9.4.4/libsodium-bindings-0.0.1.0/doc/html/libsodium-bindings/index.html: cannot open `/tmp/libsodium-bindings/dist-newstyle/build/x86_64-linux/ghc-9.4.4/libsodium-bindings-0.0.1.0/doc/html/libsodium-bindings/index.html' (No such file or directory)

Expected behavior
The files that are advertised to be produced should be here

System information

  • Fedora 37
  • cabal-install version 3.10.1.0
  • The Glorious Glasgow Haskell Compilation System, version 9.4.4
@Kleidukos Kleidukos changed the title Top-level index.html that are supposed to be produced by cabal haddock-project are not here. The index.html that are supposed to be produced by cabal haddock-project are not here. Mar 13, 2023
@Kleidukos Kleidukos mentioned this issue Mar 18, 2023
Closed
@Kleidukos
Copy link
Member Author

@coot May I assign you to this?

@coot coot self-assigned this Mar 28, 2023
@coot
Copy link
Collaborator

coot commented Mar 28, 2023

You need to pass --gen-contents to generate haddock/index.html; the message:

Documentation created: haddocks/index.html

is misleading though.

One really wants to use one of: cabal haddock-project --local or cabal haddock-project --hackage.

@coot coot mentioned this issue Apr 25, 2023
Merged
4 tasks
@mergify mergify bot closed this as completed in #8919 Jul 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@coot coot

Labels
cabal-install: cmd/haddock
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

haddock-project fixes haskell/cabal
2 participants
@coot @Kleidukos