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

Add buildDhall*Package support for generating documentation #104980

Merged
merged 1 commit into from Dec 1, 2020

Conversation

Gabriella439
Copy link
Contributor

The buildDhall{Directory,GitHub}Package utilities now take an
optional document argument for generating documentation using
dhall-docs. The documentation is stored underneath the ./docs
subdirectory of the build product.

Motivation for this change

These utilities will be used to generate package documentation served
under a subdomain of dhall-lang.org

Things done
  • Tested using sandboxing (nix.useSandbox on NixOS, or option sandbox in nix.conf on non-NixOS linux)
  • Built on platform(s)
    • NixOS
    • macOS
    • other Linux distributions
  • Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests)
  • Tested compilation of all pkgs that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review wip"
  • Tested execution of all binary files (usually in ./result/bin/)
  • Determined the impact on package closure size (by running nix path-info -S before and after)
  • Ensured that relevant documentation is up to date
  • Fits CONTRIBUTING.md.

The `buildDhall{Directory,GitHub}Package` utilities now take an
optional `document` argument for generating documentation using
`dhall-docs`.  The documentation is stored underneath the `./docs`
subdirectory of the build product.
Gabriella439 added a commit to dhall-lang/dhall-haskell that referenced this pull request Nov 26, 2020
The corresponding Nixpkgs pull request for this is:

NixOS/nixpkgs#104980

If the user supplies the `--document` switch then the generated
Nixpkgs package will generate documentation using `dhall-docs`
@Gabriella439
Copy link
Contributor Author

cc: @ehmry

@ehmry ehmry merged commit 6dac8e6 into NixOS:master Dec 1, 2020
@ehmry
Copy link
Contributor

ehmry commented Dec 1, 2020

Nice.

Gabriella439 added a commit to dhall-lang/dhall-haskell that referenced this pull request Dec 4, 2020
The corresponding Nixpkgs pull request for this is:

NixOS/nixpkgs#104980

If the user supplies the `--document` switch then the generated
Nixpkgs package will generate documentation using `dhall-docs`
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants