nix-community.nixvim/docs/lib/pages.nix

# This file contains a list of function reference docs pages that should be generated by `nixdoc`
#
# Note: `nixdoc` uses `rnix` to parse the input file, so the file must return a fairly simple attrset.
# If there is an issue parsing the file, the resulting markdown will not contain any function docs.

{
  # TODO
}
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			# This file contains a list of function reference docs pages that should be generated by `nixdoc`
			`#`
			# Note: `nixdoc` uses `rnix` to parse the input file, so the file must return a fairly simple attrset.
			`# If there is an issue parsing the file, the resulting markdown will not contain any function docs.`

			`{`
			`# TODO`
			`}`