Skip to content

Commit

Permalink
Rename markdown docs generator
Browse files Browse the repository at this point in the history
This makes it a little clearer that it's building markdown. There are
other output formats like manual pages that I don't want to rule out
yet.
  • Loading branch information
PsychoLlama committed Jan 11, 2025
1 parent 7433d38 commit 9854b04
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 4 deletions.
6 changes: 4 additions & 2 deletions flake.nix
Original file line number Diff line number Diff line change
Expand Up @@ -160,16 +160,18 @@

packages = eachSystem (
system: pkgs: rec {
nixos-configs-doc = pkgs.callPackage lib.dotfiles.generateDocs {
nixos-configs-doc = pkgs.callPackage lib.dotfiles.generateMarkdownDocs {
platform = "nixos";
prefix = "psychollama.";
modules = [
home-manager.nixosModules.home-manager
self.nixosModules.nixos-platform
self.nixosModules.nixos-configs
];
};

editor-configs-doc = pkgs.callPackage lib.dotfiles.generateDocs {
editor-configs-doc = pkgs.callPackage lib.dotfiles.generateMarkdownDocs {
prefix = "psychollama.";
modules = [
self.nixosModules.editor-platform
self.nixosModules.editor-configs
Expand Down
2 changes: 1 addition & 1 deletion lib/default.nix
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ flake-inputs.nixpkgs.lib.extend (
dotfiles = {
hosts = import ./hosts.nix flake-inputs;
buildEditor = import ./build-editor.nix flake-inputs;
generateDocs = import ./generate-docs.nix flake-inputs;
generateMarkdownDocs = import ./generate-markdown-docs.nix flake-inputs;
};
}
)
3 changes: 2 additions & 1 deletion lib/generate-docs.nix → lib/generate-markdown-docs.nix
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
lib,
pkgs,
modules,
prefix,
platform ? null,
}:

Expand Down Expand Up @@ -37,7 +38,7 @@ let

# Only generate documentation for things under the `psychollama.*` namespace.
filteredOptions = lib.filter (
opt: opt.visible && !opt.internal && (lib.hasPrefix "psychollama." opt.name)
opt: opt.visible && !opt.internal && (lib.hasPrefix prefix opt.name)
) allOptions;

# Convert to the format expected by `nixos-render-docs`.
Expand Down

0 comments on commit 9854b04

Please sign in to comment.