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

Fix header for generated Dhall documentation #109337

Merged
merged 1 commit into from Jan 14, 2021

Conversation

@Gabriel439
Copy link
Contributor

@Gabriel439 Gabriel439 commented Jan 14, 2021

By default, dhall-docs uses the name of the input directory
as the initial component of the documentation header. However,
since the input directory is built using Nix the header contains
the Nix store hash in the name, which then appears in the
generated documentation.

The fix is to override this default behavior by supplying the
--package-name flag to dhall-docs.

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.
By default, `dhall-docs` uses the name of the input directory
as the initial component of the documentation header.  However,
since the input directory is built using Nix the header contains
the Nix store hash in the name, which then appears in the
generated documentation.

The fix is to override this default behavior by supplying the
`--package-name` flag to `dhall-docs`.
@Gabriel439 Gabriel439 requested a review from Profpatsch as a code owner Jan 14, 2021
@Gabriel439
Copy link
Contributor Author

@Gabriel439 Gabriel439 commented Jan 14, 2021

cc: @ehmry

@Gabriel439
Copy link
Contributor Author

@Gabriel439 Gabriel439 commented Jan 14, 2021

Here's an example of what the documentation looks like before the fix:

Screenshot_20210113_195638

… and here is what it looks like after the fix:

Screenshot_20210113_200244

@cole-h
cole-h approved these changes Jan 14, 2021
Copy link
Member

@cole-h cole-h left a comment

Definitely looks nicer; diff LGTM.

@ehmry ehmry merged commit 710038a into NixOS:master Jan 14, 2021
16 checks passed
16 checks passed
tests
Details
action
Details
Evaluation Performance Report Evaluator Performance Report
Details
Wait for ofborg
Details
grahamcofborg-eval ^.^!
Details
grahamcofborg-eval-check-meta config.nix: checkMeta = true
Details
grahamcofborg-eval-darwin nix-instantiate --arg nixpkgs { outPath=./.; revCount=999999; shortRev="41c31b9"; rev="41c31b9867e2a437d5d9dada1e6b43d3b5ef4b90"; } ./pkgs/t
Details
grahamcofborg-eval-lib-tests nix-build --arg pkgs import ./. {} ./lib/tests/release.nix
Details
grahamcofborg-eval-nixos nix-instantiate --arg nixpkgs { outPath=./.; revCount=999999; shortRev="41c31b9"; rev="41c31b9867e2a437d5d9dada1e6b43d3b5ef4b90"; } ./nixos/
Details
grahamcofborg-eval-nixos-manual nix-instantiate --arg nixpkgs { outPath=./.; revCount=999999; shortRev="41c31b9"; rev="41c31b9867e2a437d5d9dada1e6b43d3b5ef4b90"; } ./nixos/
Details
grahamcofborg-eval-nixos-options nix-instantiate --arg nixpkgs { outPath=./.; revCount=999999; shortRev="41c31b9"; rev="41c31b9867e2a437d5d9dada1e6b43d3b5ef4b90"; } ./nixos/
Details
grahamcofborg-eval-nixpkgs-manual nix-instantiate --arg nixpkgs { outPath=./.; revCount=999999; shortRev="41c31b9"; rev="41c31b9867e2a437d5d9dada1e6b43d3b5ef4b90"; } ./pkgs/t
Details
grahamcofborg-eval-nixpkgs-tarball nix-instantiate --arg nixpkgs { outPath=./.; revCount=999999; shortRev="41c31b9"; rev="41c31b9867e2a437d5d9dada1e6b43d3b5ef4b90"; } ./pkgs/t
Details
grahamcofborg-eval-nixpkgs-unstable-jobset nix-instantiate --arg nixpkgs { outPath=./.; revCount=999999; shortRev="41c31b9"; rev="41c31b9867e2a437d5d9dada1e6b43d3b5ef4b90"; } ./pkgs/t
Details
grahamcofborg-eval-package-list nix-env -qa --json --file .
Details
grahamcofborg-eval-package-list-no-aliases nix-env -qa --json --file . --arg config { allowAliases = false; }
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

3 participants
You can’t perform that action at this time.