docs: fix build failures

This commit is contained in:
raf 2023-10-01 16:58:05 +03:00
commit c223d49274
No known key found for this signature in database
GPG key ID: 02D1DD3FA08B6B29
3 changed files with 20 additions and 15 deletions

View file

@ -14,26 +14,31 @@
<refsection>
<title>Description</title>
<para>
Custom configuration is done with the neovim-flake.lib.neovimConfiguration if home-manager module is not in use.
It takes in the configuration as a module.
Custom configuration is done with the neovim-flake.lib.neovimConfiguration if home-manager module is not in use.
It takes in the configuration as a module.
<programlisting>
neovim-flake.lib.neovimConfiguration {
inherit pkgs;
modules = [{config = xxx;}];
};
</programlisting>
The output of the configuration function is an attrset.
</para>
<programlisting>
<para>
In case of the home-manager module, all options will be available under programs.neovim-flake once the module has
been imported from the flake inputs.
<programlisting>
{
options = "The options that were available to configure";
config = "The outputted configuration";
pkgs = "The package set used to evaluate the module";
neovim = "The built neovim package";
}
</programlisting>
In case of the home-manager module, all options will be available under programs.neovim-flake once the module has
been imported from the flake inputs.
</programlisting>
</para>
</refsection>
<refsection>
<title>Options</title>