From c1ae35d34a57651b2bcb99c5e80a6dc524d805e0 Mon Sep 17 00:00:00 2001 From: eldritch horrors Date: Mon, 8 Apr 2024 20:08:53 +0200 Subject: [PATCH] docs: don't compute SUMMARY.md during build this would make meson build compatibility unnecessarily hard and the cli does not change often enough to justify this complexity. Change-Id: I17b1870cdf8538feeaa01a9945db97af2175a642 --- .gitignore | 1 - doc/manual/generate-manpage.nix | 8 +- doc/manual/local.mk | 4 - doc/manual/src/{SUMMARY.md.in => SUMMARY.md} | 87 +++++++++++++++++++- 4 files changed, 87 insertions(+), 13 deletions(-) rename doc/manual/src/{SUMMARY.md.in => SUMMARY.md} (62%) diff --git a/.gitignore b/.gitignore index c385ef940..d25f6310f 100644 --- a/.gitignore +++ b/.gitignore @@ -21,7 +21,6 @@ perl/Makefile.config /doc/manual/conf-file.json /doc/manual/language.json /doc/manual/xp-features.json -/doc/manual/src/SUMMARY.md /doc/manual/src/command-ref/new-cli /doc/manual/src/command-ref/conf-file.md /doc/manual/src/command-ref/experimental-features-shortlist.md diff --git a/doc/manual/generate-manpage.nix b/doc/manual/generate-manpage.nix index cabfdd0d8..5c6a2a48a 100644 --- a/doc/manual/generate-manpage.nix +++ b/doc/manual/generate-manpage.nix @@ -182,12 +182,6 @@ let toplevel = commandInfo.args; }; - tableOfContents = - let - showEntry = page: " - [${page.command}](command-ref/new-cli/${page.name})"; - in - concatStringsSep "\n" (map showEntry manpages) + "\n"; - storeDocs = let showStore = @@ -227,4 +221,4 @@ let in concatStrings (attrValues (mapAttrs showStore commandInfo.stores)); in -(listToAttrs manpages) // { "SUMMARY.md" = tableOfContents; } +listToAttrs manpages diff --git a/doc/manual/local.mk b/doc/manual/local.mk index 857b40ddd..45b508eb8 100644 --- a/doc/manual/local.mk +++ b/doc/manual/local.mk @@ -60,10 +60,6 @@ $(d)/nix.conf.5: $(d)/src/command-ref/conf-file.md $(d)/nix-profiles.5: $(d)/src/command-ref/files/profiles.md $(trace-gen) doc/manual/render-manpage.sh "$$(basename $@ .5)" 5 $^ $^.tmp $@ -$(d)/src/SUMMARY.md: $(d)/src/SUMMARY.md.in $(d)/src/command-ref/new-cli $(d)/src/contributing/experimental-feature-descriptions.md - @cp $< $@ - @doc/manual/process-includes.sh $@ $@ - $(d)/src/command-ref/new-cli: $(d)/nix.json $(d)/utils.nix $(d)/generate-manpage.nix $(doc_nix) @rm -rf $@ $@.tmp $(trace-gen) $(nix-eval) --write-to $@.tmp --expr 'import doc/manual/generate-manpage.nix true (builtins.readFile $<)' diff --git a/doc/manual/src/SUMMARY.md.in b/doc/manual/src/SUMMARY.md similarity index 62% rename from doc/manual/src/SUMMARY.md.in rename to doc/manual/src/SUMMARY.md index 170217704..7747b9061 100644 --- a/doc/manual/src/SUMMARY.md.in +++ b/doc/manual/src/SUMMARY.md @@ -88,7 +88,92 @@ - [nix-instantiate](command-ref/nix-instantiate.md) - [nix-prefetch-url](command-ref/nix-prefetch-url.md) - [Experimental Commands](command-ref/experimental-commands.md) -{{#include ./command-ref/new-cli/SUMMARY.md}} + - [nix](command-ref/new-cli/nix.md) + - [nix build](command-ref/new-cli/nix3-build.md) + - [nix bundle](command-ref/new-cli/nix3-bundle.md) + - [nix copy](command-ref/new-cli/nix3-copy.md) + - [nix daemon](command-ref/new-cli/nix3-daemon.md) + - [nix derivation](command-ref/new-cli/nix3-derivation.md) + - [nix derivation add](command-ref/new-cli/nix3-derivation-add.md) + - [nix derivation show](command-ref/new-cli/nix3-derivation-show.md) + - [nix develop](command-ref/new-cli/nix3-develop.md) + - [nix doctor](command-ref/new-cli/nix3-doctor.md) + - [nix edit](command-ref/new-cli/nix3-edit.md) + - [nix eval](command-ref/new-cli/nix3-eval.md) + - [nix flake](command-ref/new-cli/nix3-flake.md) + - [nix flake archive](command-ref/new-cli/nix3-flake-archive.md) + - [nix flake check](command-ref/new-cli/nix3-flake-check.md) + - [nix flake clone](command-ref/new-cli/nix3-flake-clone.md) + - [nix flake info](command-ref/new-cli/nix3-flake-info.md) + - [nix flake init](command-ref/new-cli/nix3-flake-init.md) + - [nix flake lock](command-ref/new-cli/nix3-flake-lock.md) + - [nix flake metadata](command-ref/new-cli/nix3-flake-metadata.md) + - [nix flake new](command-ref/new-cli/nix3-flake-new.md) + - [nix flake prefetch](command-ref/new-cli/nix3-flake-prefetch.md) + - [nix flake show](command-ref/new-cli/nix3-flake-show.md) + - [nix flake update](command-ref/new-cli/nix3-flake-update.md) + - [nix fmt](command-ref/new-cli/nix3-fmt.md) + - [nix hash](command-ref/new-cli/nix3-hash.md) + - [nix hash file](command-ref/new-cli/nix3-hash-file.md) + - [nix hash path](command-ref/new-cli/nix3-hash-path.md) + - [nix hash to-base16](command-ref/new-cli/nix3-hash-to-base16.md) + - [nix hash to-base32](command-ref/new-cli/nix3-hash-to-base32.md) + - [nix hash to-base64](command-ref/new-cli/nix3-hash-to-base64.md) + - [nix hash to-sri](command-ref/new-cli/nix3-hash-to-sri.md) + - [nix help](command-ref/new-cli/nix3-help.md) + - [nix help-stores](command-ref/new-cli/nix3-help-stores.md) + - [nix key](command-ref/new-cli/nix3-key.md) + - [nix key convert-secret-to-public](command-ref/new-cli/nix3-key-convert-secret-to-public.md) + - [nix key generate-secret](command-ref/new-cli/nix3-key-generate-secret.md) + - [nix log](command-ref/new-cli/nix3-log.md) + - [nix nar](command-ref/new-cli/nix3-nar.md) + - [nix nar cat](command-ref/new-cli/nix3-nar-cat.md) + - [nix nar dump-path](command-ref/new-cli/nix3-nar-dump-path.md) + - [nix nar ls](command-ref/new-cli/nix3-nar-ls.md) + - [nix path-info](command-ref/new-cli/nix3-path-info.md) + - [nix print-dev-env](command-ref/new-cli/nix3-print-dev-env.md) + - [nix profile](command-ref/new-cli/nix3-profile.md) + - [nix profile diff-closures](command-ref/new-cli/nix3-profile-diff-closures.md) + - [nix profile history](command-ref/new-cli/nix3-profile-history.md) + - [nix profile install](command-ref/new-cli/nix3-profile-install.md) + - [nix profile list](command-ref/new-cli/nix3-profile-list.md) + - [nix profile remove](command-ref/new-cli/nix3-profile-remove.md) + - [nix profile rollback](command-ref/new-cli/nix3-profile-rollback.md) + - [nix profile upgrade](command-ref/new-cli/nix3-profile-upgrade.md) + - [nix profile wipe-history](command-ref/new-cli/nix3-profile-wipe-history.md) + - [nix realisation](command-ref/new-cli/nix3-realisation.md) + - [nix realisation info](command-ref/new-cli/nix3-realisation-info.md) + - [nix registry](command-ref/new-cli/nix3-registry.md) + - [nix registry add](command-ref/new-cli/nix3-registry-add.md) + - [nix registry list](command-ref/new-cli/nix3-registry-list.md) + - [nix registry pin](command-ref/new-cli/nix3-registry-pin.md) + - [nix registry remove](command-ref/new-cli/nix3-registry-remove.md) + - [nix repl](command-ref/new-cli/nix3-repl.md) + - [nix run](command-ref/new-cli/nix3-run.md) + - [nix search](command-ref/new-cli/nix3-search.md) + - [nix shell](command-ref/new-cli/nix3-shell.md) + - [nix show-config](command-ref/new-cli/nix3-show-config.md) + - [nix store](command-ref/new-cli/nix3-store.md) + - [nix store add-file](command-ref/new-cli/nix3-store-add-file.md) + - [nix store add-path](command-ref/new-cli/nix3-store-add-path.md) + - [nix store cat](command-ref/new-cli/nix3-store-cat.md) + - [nix store copy-log](command-ref/new-cli/nix3-store-copy-log.md) + - [nix store copy-sigs](command-ref/new-cli/nix3-store-copy-sigs.md) + - [nix store delete](command-ref/new-cli/nix3-store-delete.md) + - [nix store diff-closures](command-ref/new-cli/nix3-store-diff-closures.md) + - [nix store dump-path](command-ref/new-cli/nix3-store-dump-path.md) + - [nix store gc](command-ref/new-cli/nix3-store-gc.md) + - [nix store ls](command-ref/new-cli/nix3-store-ls.md) + - [nix store make-content-addressed](command-ref/new-cli/nix3-store-make-content-addressed.md) + - [nix store optimise](command-ref/new-cli/nix3-store-optimise.md) + - [nix store path-from-hash-part](command-ref/new-cli/nix3-store-path-from-hash-part.md) + - [nix store ping](command-ref/new-cli/nix3-store-ping.md) + - [nix store prefetch-file](command-ref/new-cli/nix3-store-prefetch-file.md) + - [nix store repair](command-ref/new-cli/nix3-store-repair.md) + - [nix store sign](command-ref/new-cli/nix3-store-sign.md) + - [nix store verify](command-ref/new-cli/nix3-store-verify.md) + - [nix upgrade-nix](command-ref/new-cli/nix3-upgrade-nix.md) + - [nix why-depends](command-ref/new-cli/nix3-why-depends.md) - [Files](command-ref/files.md) - [nix.conf](command-ref/conf-file.md) - [Profiles](command-ref/files/profiles.md)