kinow
commented
2 years ago This PR uses a patched version of https://github.com/sphinx-contrib/sphinxcontrib-runcmd. The patches include:
- Adds
$to the command executed, similarly to what we have with the{code-block}directive; - Adds a parameter to change the working directory before executing the command (i.e. equivalent of
cd src/_includes/cwl/before running the specified command); - Redirects stderr to stdout, so we get the exact same output as in a terminal, instead of two concatenated outputs as in the original code;
- By default uses
syntax: bashinstead of text (since we will use it for running commands, that makes more sense); - Removes ansi colors that are not rendered correctly by Sphinx;
The directive is not actively maintained, with low code activity. I will prepare pull requests over the next weeks/months, but the author may decide not to accept every PR (also, the directive itself is a wrapper around code-block, so we could even build another directive on top of it, instead of patching it, when/if we have more time).
Here's an example of what we had before:
```{code-block} console
:name: running-hello_world.cwl-with-cwltool
:caption: Running `hello_world.cwl` with `cwltool`.
$ cwltool hello_world.cwl
INFO /tmp/venv/bin/cwltool 3.1.20220628170238
INFO Resolved 'hello_world.cwl' to 'file:///tmp/hello_world.cwl'
INFO [job hello_world.cwl] /tmp/yn0e8xu6$ echo \
'Hello World'
Hello World
INFO [job hello_world.cwl] completed success
{}
INFO Final process status is success
Which renders to:
With the new directive, we have:
:name: running-hello_world.cwl-with-cwltool
:caption: Running `hello_world.cwl` with `cwltool`.
Which renders to:
mr-c
Closes #148
{code-block} consolethat usescwltoolor another command that we would like to run during build (have updated a few files from the beginning of the docs, following the Next links… I think up to the second section of Topics).