Skip to content

Export the docs module #103

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 11, 2024
Merged

Export the docs module #103

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/default.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ in {

renderDocs = {
enable = true;
name = "cardano-nix-docs";
mkdocsYamlFile = ./mkdocs.yml;
sidebarOptions = [
{
anchor = "cardano";
Expand Down
145 changes: 87 additions & 58 deletions docs/render.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,12 @@
config,
inputs,
lib,
self,
...
}: let
cfg = config.renderDocs;

inherit (lib) mkOption mkEnableOption mkIf;
inherit (lib) mkOption mkEnableOption mkIf mkMerge;
inherit (lib.types) bool str listOf deferredModule submodule path;

sidebarType = submodule {
Expand Down Expand Up @@ -50,11 +51,31 @@
in {
options.renderDocs = {
enable = mkEnableOption "Document rendering";
name = mkOption {
type = str;
description = ''
Title of the documentation
'';
};
packageName = mkOption {
type = str;
default = "docs";
description = ''
Name of package with generated documentation (in flake outputs)
Name of package containing the documentation
'';
};
mkdocsYamlFile = mkOption {
type = path;
default = "${self}/docs/mkdocs.yml";
description = ''
Path to the mkdocs.yml file
'';
};
devshells = mkOption {
type = listOf str;
default = ["default"];
description = ''
Names of the devshells to add `docs-serve` and `docs-build` commands to
'';
};

Expand All @@ -75,7 +96,7 @@ in {
type = bool;
default = false;
description = ''
render invisible options as well
Render invisible options as well
'';
};
};
Expand Down Expand Up @@ -203,70 +224,78 @@ in {
pkgs.runCommand "mkdocs.yaml" {
nativeBuildInputs = [pkgs.yq-go];
} ''
yq '. *+ load("${indexYAML}")' ${./mkdocs.yml} -o yaml >$out
yq '. *+ load("${indexYAML}")' ${cfg.mkdocsYamlFile} -o yaml >$out
'';
in {
packages.${cfg.packageName} = stdenv.mkDerivation {
src = ../.; # FIXME: use config.flake-root.package here
name = "cardano-nix-docs";

nativeBuildInputs = [my-mkdocs];
in
mkMerge ([
{
packages.${cfg.packageName} = stdenv.mkDerivation {
src = ../.; # FIXME: use config.flake-root.package here
# src = builtins.trace config.flake-root.package config.flake-root.package;
inherit (cfg) name;

buildPhase = ''
ln -s ${options-doc} ${docsPath}
# mkdocs expect mkdocs one level upper than `docs/`, but we want to keep it in `docs/`
cp ${mergedMkdocsYaml} mkdocs.yml
mkdocs build -f mkdocs.yml -d site
'';
nativeBuildInputs = [my-mkdocs];

installPhase = ''
mv site $out
rm $out/default.nix # Clean unwanted side-effect of mkdocs
'';
buildPhase = ''
ln -s ${options-doc} ${docsPath}
# mkdocs expect mkdocs one level upper than `docs/`, but we want to keep it in `docs/`
cp ${mergedMkdocsYaml} mkdocs.yml
mkdocs build -f mkdocs.yml -d site
'';

passthru.serve = pkgs.writeShellScriptBin "serve" ''
set -euo pipefail
installPhase = ''
mv site $out
rm $out/default.nix # Clean unwanted side-effect of mkdocs
'';

# link in options reference
rm -f ${docsPath}
ln -s ${options-doc} ${docsPath}
rm -f mkdocs.yml
ln -s ${mergedMkdocsYaml} mkdocs.yml
passthru.serve = pkgs.writeShellScriptBin "serve" ''
set -euo pipefail

BASEDIR="$(${lib.getExe config.flake-root.package})"
cd $BASEDIR
# link in options reference
rm -f ${docsPath}
ln -s ${options-doc} ${docsPath}
rm -f mkdocs.yml
ln -s ${mergedMkdocsYaml} mkdocs.yml

cat <<EOF
NOTE: Documentation/index autogenerated from NixOS options doesn't reload automatically
NOTE: Please restart 'docs-serve' for it
EOF
${my-mkdocs}/bin/mkdocs serve
'';
};
BASEDIR="$(${lib.getExe config.flake-root.package})"
cd $BASEDIR

packages."${cfg.packageName}-serve" = config.packages.${cfg.packageName}.serve;
cat <<EOF
NOTE: Documentation/index autogenerated from NixOS options doesn't reload automatically
NOTE: Please restart 'docs-serve' for it
EOF
${my-mkdocs}/bin/mkdocs serve
'';
};

devshells.default = {
commands = let
category = "documentation";
in [
{
inherit category;
name = "docs-serve";
help = "serve documentation web page";
command = "nix run .#${cfg.packageName}-serve";
}
{
inherit category;
name = "docs-build";
help = "build documentation";
command = "nix build .#${cfg.packageName}";
packages."${cfg.packageName}-serve" = config.packages.${cfg.packageName}.serve;
}
];
packages = [
my-mkdocs
];
};
};
]
++ (
builtins.map (devshell: {
devshells."${devshell}" = {
commands = let
category = "documentation";
in [
{
inherit category;
name = "docs-serve";
help = "serve documentation web page";
command = "nix run .#${cfg.packageName}-serve";
}
{
inherit category;
name = "docs-build";
help = "build documentation";
command = "nix build .#${cfg.packageName}";
}
];
packages = [
my-mkdocs
];
};
})
cfg.devshells
));
};
}
2 changes: 2 additions & 0 deletions modules/default.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
config,
...
}: {
flake.flakeModules.docs = ../docs/render.nix;

flake.nixosModules = {
cardano = {
imports = [
Expand Down