From 7a0c450662d8faef314c895d7ee9006879a256fc Mon Sep 17 00:00:00 2001 From: Shawn Davis Date: Tue, 1 Feb 2022 21:55:02 -0600 Subject: [PATCH] Better handling for explain snippet in docs output. --- sandbox/cli.py | 4 ++++ scripttease/data/inventory/radicale/steps.ini | 11 +++++++++++ 2 files changed, 15 insertions(+) diff --git a/sandbox/cli.py b/sandbox/cli.py index 79ca964..23ad89a 100755 --- a/sandbox/cli.py +++ b/sandbox/cli.py @@ -216,6 +216,10 @@ This command is used to parse configuration files and output the commands. continue if snippet.name == "explain": + if snippet.header: + output.append("## %s" % snippet.name.title()) + output.append("") + output.append(snippet.args[0]) output.append("") elif snippet.name == "screenshot": diff --git a/scripttease/data/inventory/radicale/steps.ini b/scripttease/data/inventory/radicale/steps.ini index bd23eb8..041c1de 100644 --- a/scripttease/data/inventory/radicale/steps.ini +++ b/scripttease/data/inventory/radicale/steps.ini @@ -1,12 +1,23 @@ +[introduction] +explain: "In this tutorial, we are going to install Radicale." +header: yes + [make sure a maintenance root exists] mkdir: /var/www/maint/www group: www-data owner: www-data recursive: yes +[about maintenance root] +explain: "The maintenance root is used to register an SSL certificate (below) before the site is completed and (later) after the site is live." + [install radicale] pip3: radicale +;[install radicale screenshot] +;screenshot: images/install.png +;caption: Radical Installed + [create radicale configuration directory] mkdir: /etc/radicale/config owner: radicale