如何将一个指令嵌套在另一个指令中,例如 . 代码块::



所以我正在尝试使用狮身人面像来构建一些python文档。我有一个扩展名 (https://github.com/lunaryorn/sphinxcontrib-programoutput(,我用它来调用我的一个源 python 文件以显示使用文本,例如.. command-output:: python ../src/something.py --help工作正常,问题是我想对输出进行颜色编码。

我试过在上面放一个.. code-block:: sh,但我无法弄清楚是否真的有办法像这样嵌套两者。

这可能吗?

编辑:更多信息

所以这是我的 rst 源文件的一部分:

..command-output:: python ../project/module.py --help

这最终将创建如下的 html:

<div class="highlight-text notranslate">
<div class="highlight">
<pre>
<span></span>
$ python ../project/module.py --help
usage: module.py [-h][-d | -q]
This is a project
optional arguments:
-h, --help            show this help message and exit
logging arguments:
Control what log level the log outputs (default: logger.INFO)
-d, --debug           Set log level to DEBUG for more verbose output
-q, --quiet           Suppress all logs except ERROR and CRITICAL
</pre>
</div>
</div>

这里的问题是用法输出只是直接的黑白,但我希望它像 shell 代码或任何其他语言一样突出显示语法(因为这个命令输出的东西可能用于其他类型的输出(。

如下所述,https://stackoverflow.com/users/2214933/steve-piercy 指出.. code-block::不能在其下方嵌套另一个指令,这是我试图开始工作的事情。因此,我正在寻找的是以某种方式能够对command-output的输出进行着色,就好像它正在被.. code-block::指令修改一样。

首先,不再支持sphinxcontrib-programoutput。我建议使用sphinxcontrib-autoprogram.

这两个扩展都会生成类似的用法块(示例 https://docs.pylonsproject.org/projects/pyramid/en/latest/pscripts/pcreate.html(,因此目前无法在输出的该部分中设置位的样式。您可以设置后续选项列表的样式。

您可以将问题作为功能请求提交,也可以自行修改源并提交 PR。

最新更新