docs: include header and footer in manpages; move man to its own dir

This commit is contained in:
raf 2024-04-21 00:29:17 +03:00
parent 25dc887a8e
commit d2b8e27b16
No known key found for this signature in database
GPG key ID: 02D1DD3FA08B6B29
4 changed files with 11 additions and 6 deletions

View file

@ -127,10 +127,12 @@
nixos-render-docs -j $NIX_BUILD_CORES options manpage \ nixos-render-docs -j $NIX_BUILD_CORES options manpage \
--revision ${revision} \ --revision ${revision} \
--header ${./man/header.5} \
--footer ${./man/footer.5} \
${nvimModuleDocs.optionsJSON}/share/doc/nixos/options.json \ ${nvimModuleDocs.optionsJSON}/share/doc/nixos/options.json \
$out/share/man/man5/neovim-flake.5 $out/share/man/man5/neovim-flake.5
cp ${./neovim-flake.1} $out/share/man/man1/neovim-flake.1 cp ${./man/neovim-flake.1} $out/share/man/man1/neovim-flake.1
''; '';
# Generate the HTML manual pages # Generate the HTML manual pages

View file

@ -9,6 +9,5 @@
neovim-flake configuration specification neovim-flake configuration specification
.SH "OPTIONS" .SH "OPTIONS"
.PP .PP
You can use the following options in You can use the following options to configure neovim-flake:
home\-configuration\&.nix:
.PP .PP

View file

@ -9,13 +9,17 @@
.cflags 4 / .cflags 4 /
.Sh NAME .Sh NAME
.Nm neovim-flake .Nm neovim-flake
.Nd a extensible and distro-agonistic Neovim configuration wrapper in Nix .Nd A highly modular, extensible and distro-agnostic Neovim distribution for Nix/NixOS.
. .
.Sh BUGS .Sh BUGS
.Pp .Pp
Please report any bugs on the Please report any bugs that you might encounter on the
\m[blue]\fBproject issue tracker\fR\m[]\&. \m[blue]\fBproject issue tracker\fR\m[]\&.
.Sh SEE ALSO
.Pp
\fBneovim-flake\fR(5)
.Sh AUTHOR .Sh AUTHOR
.Pp .Pp
\fBneovim-flake contributors\fR \fBneovim-flake contributors\fR
@ -25,5 +29,5 @@ Author.
.Sh COPYRIGHT .Sh COPYRIGHT
.br .br
Copyright \(co 2017\(en2022 neovim-flake contributors Copyright \(co 2023\(en2024 neovim-flake contributors
.br .br