From fb9c22056faa95f35749f116c49c5c202ceb159c Mon Sep 17 00:00:00 2001 From: awwpotato Date: Tue, 20 May 2025 02:26:52 -0700 Subject: [PATCH] doc: move to doc directory (#1272) --- {docs => doc}/book.toml | 2 +- {docs => doc}/default.nix | 6 +++--- {docs => doc}/settings.nix | 0 {docs => doc}/src/SUMMARY.md | 0 {docs => doc}/src/commit_convention.md | 0 {docs => doc}/src/configuration.md | 0 {docs => doc}/src/development_environment.md | 0 {docs => doc}/src/installation.md | 0 {docs => doc}/src/modules.md | 0 {docs => doc}/src/options/platforms/home_manager.md | 0 {docs => doc}/src/options/platforms/nixos.md | 0 {docs => doc}/src/styling.md | 0 {docs => doc}/src/testbed_gnome_default_dark.png | Bin {docs => doc}/src/testbeds.md | 0 {docs => doc}/src/tricks.md | 0 flake/packages.nix | 2 +- 16 files changed, 5 insertions(+), 5 deletions(-) rename {docs => doc}/book.toml (95%) rename {docs => doc}/default.nix (98%) rename {docs => doc}/settings.nix (100%) rename {docs => doc}/src/SUMMARY.md (100%) rename {docs => doc}/src/commit_convention.md (100%) rename {docs => doc}/src/configuration.md (100%) rename {docs => doc}/src/development_environment.md (100%) rename {docs => doc}/src/installation.md (100%) rename {docs => doc}/src/modules.md (100%) rename {docs => doc}/src/options/platforms/home_manager.md (100%) rename {docs => doc}/src/options/platforms/nixos.md (100%) rename {docs => doc}/src/styling.md (100%) rename {docs => doc}/src/testbed_gnome_default_dark.png (100%) rename {docs => doc}/src/testbeds.md (100%) rename {docs => doc}/src/tricks.md (100%) diff --git a/docs/book.toml b/doc/book.toml similarity index 95% rename from docs/book.toml rename to doc/book.toml index df886df9..2a0ede31 100644 --- a/docs/book.toml +++ b/doc/book.toml @@ -7,7 +7,7 @@ language = "en" [output.html] site-url = "/stylix/" git-repository-url = "https://github.com/nix-community/stylix" -edit-url-template = "https://github.com/nix-community/stylix/edit/master/docs/{path}" +edit-url-template = "https://github.com/nix-community/stylix/edit/master/doc/{path}" no-section-label = true [output.html.fold] diff --git a/docs/default.nix b/doc/default.nix similarity index 98% rename from docs/default.nix rename to doc/default.nix index f2147ae0..2f4a3d69 100644 --- a/docs/default.nix +++ b/doc/default.nix @@ -73,7 +73,7 @@ let # "src/options/platforms/«platform».md" = { # referenceSection = "Platforms"; # readme = '' - # Content of docs/src/options/platforms/«platform».md, or a default + # Content of doc/src/options/platforms/«platform».md, or a default # title followed by a note about that file not existing. # ''; # optionsByPlatform.«platform» = [ ... ]; @@ -237,7 +237,7 @@ let referenceSection = "Platforms"; readme = let - path = "${inputs.self}/docs/src/options/platforms/${platform}.md"; + path = "${inputs.self}/doc/src/options/platforms/${platform}.md"; # This doesn't count as IFD because ${inputs.self} is a flake input mainText = @@ -550,7 +550,7 @@ let ); # This function generates a Bash script that installs each page to the - # correct location, over the top of an original copy of docs/src. + # correct location, over the top of an original copy of doc/src. # # Each page must be written in a separate derivation, because passing all # the text into a single derivation exceeds the maximum size of command diff --git a/docs/settings.nix b/doc/settings.nix similarity index 100% rename from docs/settings.nix rename to doc/settings.nix diff --git a/docs/src/SUMMARY.md b/doc/src/SUMMARY.md similarity index 100% rename from docs/src/SUMMARY.md rename to doc/src/SUMMARY.md diff --git a/docs/src/commit_convention.md b/doc/src/commit_convention.md similarity index 100% rename from docs/src/commit_convention.md rename to doc/src/commit_convention.md diff --git a/docs/src/configuration.md b/doc/src/configuration.md similarity index 100% rename from docs/src/configuration.md rename to doc/src/configuration.md diff --git a/docs/src/development_environment.md b/doc/src/development_environment.md similarity index 100% rename from docs/src/development_environment.md rename to doc/src/development_environment.md diff --git a/docs/src/installation.md b/doc/src/installation.md similarity index 100% rename from docs/src/installation.md rename to doc/src/installation.md diff --git a/docs/src/modules.md b/doc/src/modules.md similarity index 100% rename from docs/src/modules.md rename to doc/src/modules.md diff --git a/docs/src/options/platforms/home_manager.md b/doc/src/options/platforms/home_manager.md similarity index 100% rename from docs/src/options/platforms/home_manager.md rename to doc/src/options/platforms/home_manager.md diff --git a/docs/src/options/platforms/nixos.md b/doc/src/options/platforms/nixos.md similarity index 100% rename from docs/src/options/platforms/nixos.md rename to doc/src/options/platforms/nixos.md diff --git a/docs/src/styling.md b/doc/src/styling.md similarity index 100% rename from docs/src/styling.md rename to doc/src/styling.md diff --git a/docs/src/testbed_gnome_default_dark.png b/doc/src/testbed_gnome_default_dark.png similarity index 100% rename from docs/src/testbed_gnome_default_dark.png rename to doc/src/testbed_gnome_default_dark.png diff --git a/docs/src/testbeds.md b/doc/src/testbeds.md similarity index 100% rename from docs/src/testbeds.md rename to doc/src/testbeds.md diff --git a/docs/src/tricks.md b/doc/src/tricks.md similarity index 100% rename from docs/src/tricks.md rename to doc/src/tricks.md diff --git a/flake/packages.nix b/flake/packages.nix index 055c7caf..75a040b8 100644 --- a/flake/packages.nix +++ b/flake/packages.nix @@ -40,7 +40,7 @@ # only available for Linux systems. (lib.mkIf pkgs.stdenv.hostPlatform.isLinux testbedPackages') { - docs = pkgs.callPackage "${self}/docs" { + docs = pkgs.callPackage "${self}/doc" { inherit inputs; inherit (inputs.nixpkgs.lib) nixosSystem; inherit (inputs.home-manager.lib) homeManagerConfiguration;