sigildocs

(sigil docs execute)

(sigil docs execute) - Executable Code Block Support

Execute code blocks in documentation and capture their output.

Supported block options: :run - Execute and show output :run-hide - Execute but hide block, show only output :run-error - Expect an error, show error message :no-prompt - Don't show > or $ prompt :session NAME - Share state between blocks with same session :continue - Continue previous block's session

Example: (execute-block block-record) -> <execution-result>

Exports

execution-resultprocedure

Construct a execution-result struct.

execution-result?procedure

Test if a value is a execution-result struct.

execution-result-outputprocedure

Get the output field of a execution-result struct.

execution-result-valueprocedure

Get the value field of a execution-result struct.

execution-result-error?procedure

Get the error? field of a execution-result struct.

execution-result-error-messageprocedure

Get the error-message field of a execution-result struct.

execution-result-durationprocedure

Get the duration field of a execution-result struct.

code-blockprocedure

Construct a code-block struct.

code-block?procedure

Test if a value is a code-block struct.

code-block-langprocedure

Get the lang field of a code-block struct.

code-block-codeprocedure

Get the code field of a code-block struct.

code-block-optionsprocedure

Get the options field of a code-block struct.

parse-block-optionsprocedure

Parse block options from info string "sigil :run :session demo" -> ((lang . "sigil") (run . #t) (session . "demo"))

parse-optionsprocedure

Parse option tokens into alist

parse-code-blockprocedure

Parse a code block from SXML pre element (pre (@ (lang "sigil :run")) "code") -> <code-block>

find-code-contentprocedure

Find code content in pre element

should-execute?procedure

Check if block should be executed

execute-blockprocedure

Execute a code block

execute-sigil-blockprocedure

Execute Sigil code block

execute-sigil-codeprocedure

Execute Sigil code string and capture output

execute-shell-blockprocedure

Execute shell command block

safe-command?procedure

Check if command is safe to execute

execute-shell-commandprocedure

Execute shell command and capture output

make-session-managerprocedure

Create a session manager for tracking execution state

session-manager-getprocedure

Get session by name

session-manager-set!procedure

Set session value