nix-community.nixvim/flake/packages.nix

{
  self,
  inputs,
  helpers,
  ...
}:
{
  perSystem =
    {
      config,
      inputs',
      system,
      ...
    }:
    {
      # Run the docs server when using `nix run .#docs`
      apps.docs.program = config.packages.serve-docs;

      packages = import ../docs {
        nixvim = self;
        inherit helpers;
        inherit system;
        inherit (inputs) nixpkgs;
        inherit (inputs') nuschtosSearch;
      };
    };
}
lib: make overrideable & access via flake Add a non-system specific `<flake>.lib.nixvim` output, which is equivalent to the existing `<flake>.lib.<system>.helpers` output. This is now also wrapped with `lib.makeOverridable` to allow overriding the function args used to construct the nixvim-lib. Consistently access nixvim-lib via the new flake output, overriding where necessary. 2024-12-21 13:40:16 +00:00			`{`
docs/lib: init Generate reference docs for functions that have RFC145 style doc-comments. 1. function locations `docs/lib/function-locations.nix` scans nixvim's extended lib, extracting "position entries" via `unsafeGetAttrPos`. This is then converted into a nixdoc `locations.json` map of "function name" → "markdown location string". 2. mdbook menu `docs/lib/menu.nix` renders a mdbook menu representing all page entries. 3. markdown pages `docs/lib/default.nix` expects a set of "page entries", which come from `docs/lib/pages.nix` by default. It passes this data to `function-locations.nix` and `menu.nix`, and uses it internally to render markdown pages. Page entries can contain a `file` to render using `nixdoc`, and also a `markdown` attribute which will be included at the top of the docs. Additionally, a `title` can be included. This forms the heading `$name: $title`, where `name` is derived from the page's attr-path. See https://github.com/nix-community/nixdoc 2025-03-05 20:44:36 +00:00			`self,`
lib: make overrideable & access via flake Add a non-system specific `<flake>.lib.nixvim` output, which is equivalent to the existing `<flake>.lib.<system>.helpers` output. This is now also wrapped with `lib.makeOverridable` to allow overriding the function args used to construct the nixvim-lib. Consistently access nixvim-lib via the new flake output, overriding where necessary. 2024-12-21 13:40:16 +00:00			`inputs,`
			`helpers,`
			`...`
			`}:`
flake.nix: refactoring using flake-parts 2023-12-06 13:09:26 +01:00			`{`
			`perSystem =`
docs: Add an option search to our documentation 2024-07-19 20:14:20 +02:00			`{`
docs: refactor `serve-docs`; add `nix run .#docs` Refactor `serve-docs` using `makeWrapper`, make it available as a `serve-docs` package and as the `docs` "app". This means `nix build .#docs` will build the docs while `nix run .#docs` will run the server. 2025-05-21 17:27:28 +01:00			`config,`
docs: Add an option search to our documentation 2024-07-19 20:14:20 +02:00			`inputs',`
docs: move pkgs overlays to their own file 2024-09-12 12:55:33 +01:00			`system,`
docs: Add an option search to our documentation 2024-07-19 20:14:20 +02:00			`...`
			`}:`
docs: Correctly generate documentation for types `either a (submodule ...)` (#929) This requires pulling quite a lot of code from nixpkgs in order to make the `either` type work correctly, the effects can be seen for example in the documentation of `ollama.promps` and `ollama.actions` 2024-01-12 23:22:03 +01:00			`{`
docs: refactor `serve-docs`; add `nix run .#docs` Refactor `serve-docs` using `makeWrapper`, make it available as a `serve-docs` package and as the `docs` "app". This means `nix build .#docs` will build the docs while `nix run .#docs` will run the server. 2025-05-21 17:27:28 +01:00			# Run the docs server when using `nix run .#docs`
			`apps.docs.program = config.packages.serve-docs;`

docs: use lib.extend instead of patching nixpkgs This speeds up evaluation and removes IFD. Additionally, this makes it easier to maintain these library changes, as we don't have to maintain static patches. Signed-off-by: Sefa Eyeoglu <contact@scrumplex.net> 2024-06-05 21:59:34 +02:00			`packages = import ../docs {`
docs/lib: init Generate reference docs for functions that have RFC145 style doc-comments. 1. function locations `docs/lib/function-locations.nix` scans nixvim's extended lib, extracting "position entries" via `unsafeGetAttrPos`. This is then converted into a nixdoc `locations.json` map of "function name" → "markdown location string". 2. mdbook menu `docs/lib/menu.nix` renders a mdbook menu representing all page entries. 3. markdown pages `docs/lib/default.nix` expects a set of "page entries", which come from `docs/lib/pages.nix` by default. It passes this data to `function-locations.nix` and `menu.nix`, and uses it internally to render markdown pages. Page entries can contain a `file` to render using `nixdoc`, and also a `markdown` attribute which will be included at the top of the docs. Additionally, a `title` can be included. This forms the heading `$name: $title`, where `name` is derived from the page's attr-path. See https://github.com/nix-community/nixdoc 2025-03-05 20:44:36 +00:00			`nixvim = self;`
lib: make overrideable & access via flake Add a non-system specific `<flake>.lib.nixvim` output, which is equivalent to the existing `<flake>.lib.<system>.helpers` output. This is now also wrapped with `lib.makeOverridable` to allow overriding the function args used to construct the nixvim-lib. Consistently access nixvim-lib via the new flake output, overriding where necessary. 2024-12-21 13:40:16 +00:00			`inherit helpers;`
docs: move pkgs overlays to their own file 2024-09-12 12:55:33 +01:00			`inherit system;`
			`inherit (inputs) nixpkgs;`
docs: Add an option search to our documentation 2024-07-19 20:14:20 +02:00			`inherit (inputs') nuschtosSearch;`
docs: use lib.extend instead of patching nixpkgs This speeds up evaluation and removes IFD. Additionally, this makes it easier to maintain these library changes, as we don't have to maintain static patches. Signed-off-by: Sefa Eyeoglu <contact@scrumplex.net> 2024-06-05 21:59:34 +02:00			`};`
flake.nix: refactoring using flake-parts 2023-12-06 13:09:26 +01:00			`};`
			`}`