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

Haddocks on Github Pages #3385

Merged
merged 5 commits into from
Apr 20, 2023
Merged

Haddocks on Github Pages #3385

merged 5 commits into from
Apr 20, 2023

Conversation

teodanciu
Copy link
Contributor

@teodanciu teodanciu commented Apr 19, 2023

Description

This PR introduces a new github workflow, triggered on master, which:

  • builds haddock for every package, aggregating them as a site (listed on the landing page)
  • deploys this site to github pages, so the haddocks will be accessible here, after the PR is merged: https://input-output-hk.github.io/cardano-ledger (replacing the current content, which seems obsolete anyway).

The links between the packages are working well (for example: when inspecting rules, clicking on anything from small-steps or cardano-core will take you there).
I'm unsatisfied for not being able to link to hackage the packages for which hackage documentation exists (like base). I was able to do this only at the cost of the links between packages not working, but I thought it's more important to have the latter working.

This is a copy of the site with this PR on my own fork, to demonstrate how the pages will look like: https://bienpulenta.github.io/cardano-ledger/

Checklist

  • Commit sequence broadly makes sense and commits have useful messages
  • New tests are added if needed and existing tests are updated
  • Any changes are noted in the CHANGELOG.md for affected package
  • The version bounds in .cabal files are updated
  • Code is formatted with fourmolu (use scripts/fourmolize.sh)
  • Cabal files are formatted (use scripts/cabal-format.sh)
  • hie.yaml has been updated (use scripts/gen-hie.sh)
  • Self-reviewed the diff

@teodanciu teodanciu requested a review from a team as a code owner April 19, 2023 10:51
Copy link
Collaborator

@lehins lehins left a comment

Choose a reason for hiding this comment

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

This is really awesome! Thank you.

It might be a good idea to add a link in the README.md to the landing page with haddocks.

scripts/prolog Outdated Show resolved Hide resolved
.github/workflows/gh-pages.yml Outdated Show resolved Hide resolved
Copy link
Contributor

@JaredCorduan JaredCorduan left a comment

Choose a reason for hiding this comment

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

❤️ ❤️ ❤️

@teodanciu teodanciu force-pushed the td/haddocks-gh-pages branch from a73c26c to 4932ece Compare April 20, 2023 12:04
@teodanciu teodanciu enabled auto-merge (rebase) April 20, 2023 12:06
@teodanciu teodanciu merged commit cd3a914 into master Apr 20, 2023
@iohk-bors iohk-bors bot deleted the td/haddocks-gh-pages branch April 20, 2023 13:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants