From 762da0989c9502aab7105a21cff192624e8e148f Mon Sep 17 00:00:00 2001 From: Michael Angerman <1809991+stormasm@users.noreply.github.com> Date: Mon, 14 Mar 2022 20:50:46 -0700 Subject: [PATCH] now that docs/commands is gone delete make_docs.nu as it is no longer needed (#4853) --- docs/make_docs.nu | 71 ----------------------------------------------- 1 file changed, 71 deletions(-) delete mode 100644 docs/make_docs.nu diff --git a/docs/make_docs.nu b/docs/make_docs.nu deleted file mode 100644 index a06d626357..0000000000 --- a/docs/make_docs.nu +++ /dev/null @@ -1,71 +0,0 @@ -let vers = (version).version - -for command in ($nu.scope.commands | where is_custom == false && is_extern == false) { - let top = $"--- -title: ($command.command) -layout: command -version: ($vers) ---- - -($command.usage) - -" - let sig = ($command.signature | each { |param| - if $param.parameter_type == "positional" { - $"('(')($param.parameter_name)(')')" - } else if $param.parameter_type == "switch" { - $"--($param.parameter_name)" - } else if $param.parameter_type == "named" { - $"--($param.parameter_name)" - } else if $param.parameter_type == "rest" { - $"...($param.parameter_name)" - } - } | str collect " ") - - let signature = $"## Signature(char nl)(char nl)```> ($command.command) ($sig)```(char nl)(char nl)" - - let params = ($command.signature | each { |param| - if $param.parameter_type == "positional" { - $" - `($param.parameter_name)`: ($param.description)" - } else if $param.parameter_type == "switch" { - $" - `--($param.parameter_name)`: ($param.description)" - } else if $param.parameter_type == "named" { - $" - `--($param.parameter_name) {($param.syntax_shape)}`: ($param.description)" - } else if $param.parameter_type == "rest" { - $" - `...($param.parameter_name)`: ($param.description)" - } - } | str collect (char nl)) - - let parameters = if ($command.signature | length) > 0 { - $"## Parameters(char nl)(char nl)($params)(char nl)(char nl)" - } else { - "" - } - - let examples = if ($command.examples | length) > 0 { - let example_top = $"## Examples(char nl)(char nl)" - - let $examples = ($command.examples | each { |example| -$"($example.description) -```shell -> ($example.example) -``` - -" - } | str collect) - - $example_top + $examples - } else { "" } - - let doc = ( - ($top + $signature + $parameters + $examples) | - lines | - each {|it| ($it | str trim -r) } | - str collect (char nl) - ) - - let safe_name = ($command.command | str find-replace '\?' '' | str find-replace ' ' '_') - $doc | save --raw $"./docs/commands/($safe_name).md" - $"./docs/commands/($safe_name).md" -} | length | $"($in) commands written" -