nixos-config

mirror of https://github.com/foo-dogsquared/nixos-config.git synced 2025-01-31 16:57:55 +00:00

History

Gabriel Arazas ae06921d64 wrapper-manager-fds/docs: update project overview		2024-07-31 21:21:48 +08:00
..
manpages	wrapper-manager-fds/docs: add HTML and manpage output for module options	2024-07-31 16:48:52 +08:00
website	wrapper-manager-fds/docs: update project overview	2024-07-31 21:21:48 +08:00
.gitignore	wrapper-manager-fds/docs: reorganize to make way for other docs output	2024-07-21 20:22:02 +08:00
default.nix	wrapper-manager-fds/docs: add HTML and manpage output for module options	2024-07-31 16:48:52 +08:00
Gemfile	wrapper-manager-fds/docs: init Ruby environment	2024-07-14 13:36:03 +08:00
Gemfile.lock	wrapper-manager-fds/docs: init Ruby environment	2024-07-14 13:36:03 +08:00
gemset.nix	wrapper-manager-fds/docs: init Ruby environment	2024-07-14 13:36:03 +08:00
hugo-build-module.nix	wrapper-manager-fds/docs: update build step for Hugo site	2024-07-20 13:33:51 +08:00
LICENSE	wrapper-manager-fds/docs: init subproject	2024-07-14 11:14:22 +08:00
README.adoc	wrapper-manager-fds/docs: reorganize to make way for other docs output	2024-07-21 20:22:02 +08:00

This is where the documentation is created, namely both the website and the manual page.

The website is powered by Hugo and it is pretty much what makes most of the files here. It requires Hugo and whatever Hugo module feature requires so it isn’t possible to build it offline. For now, we rely on the remote CI having network access for it (which is pretty much the standard for the most part so no worries there).
The manual page is powered by some under-documented tool in the Nix ecosystem (as is tradition) called nixos-render-docs. The adjacent tools in the Nix-module-options-doc-generation ecosystem are also what makes the (autogenerated) Nix module options pages found in the website.