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.

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

New ./scripts/combined-haddock.sh #6205

Merged
merged 8 commits into from
Jun 19, 2024
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/combined-haddock.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ jobs:

- name: Build Haddock
run: |
nix develop --accept-flake-config --command bash ./scripts/combined-haddock.sh
nix develop --accept-flake-config --command bash ./scripts/combined-haddock.sh haddock all

- name: Deploy Haddock
uses: JamesIves/github-pages-deploy-action@v4
Expand Down
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ cabal-dev
cabal.sandbox.config
cabal.config
cabal.project.local
cabal.project.freeze

# Stack
.stack-work
Expand Down Expand Up @@ -99,7 +100,8 @@ node.sock
.pre-commit-config.yaml
secrets/*/.gpg-id
ghcid.txt
combined_haddock*
haddock
linkchecker-out.txt
plutus-pab/test-node/testnet/db
plutus-pab/test-node/alonzo-purple/db
*.actual.json
Expand Down
12 changes: 1 addition & 11 deletions nix/project.nix
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ let
src = ../.;

shell = {
withHoogle = false;
withHoogle = true;
Copy link
Contributor Author

@zeme-wana zeme-wana Jun 17, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need this to get h.nix to include haddock for all dependencies

# We would expect R to be pulled in automatically as it's a dependency of
# plutus-core, but it appears it is not, so we need to be explicit about
# the dependency on R here. Adding it as a buildInput will ensure it's
Expand Down Expand Up @@ -80,16 +80,6 @@ let
# Common
{
packages = {
# Packages we just don't want docs for
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These were probably obsolete: we can build haddock successfully for all these

plutus-benchmark.doHaddock = false;

# FIXME: Haddock mysteriously gives a spurious missing-home-modules warning
plutus-tx-plugin.doHaddock = false;

# Something goes wrong with the custom setup
# https://github.com/input-output-hk/haskell.nix/issues/2019
prettyprinter-configurable.doHaddock = false;

# In this case we can just propagate the native dependencies for the build of
# the test executable, which are actually set up right (we have a
# build-tool-depends on the executable we need)
Expand Down
1 change: 1 addition & 0 deletions nix/shell.nix
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ in
pkgs.gawk
pkgs.scriv
pkgs.fswatch
pkgs.linkchecker

# Needed to make building things work, not for commands
pkgs.zlib
Expand Down
Loading
Loading