Sphinx-在代码块摘要中使用省略号(...)

问题描述 投票:0回答:1

考虑到您记录了一个长长的代码段,并希望用省略号…(…)和垂直省略号⋮来表示重复的值和其中的行。 (⋮)。

这是JSON中的示例记录。有26个孩子,您不想显示全部。

.. code-block:: json

   {
       "total": 26,
       "kids" [
           {
               "_id":  1,
               "name": "Alice",
               "age":  3
           },
           {
               "_id":  2,
               "name": "Becky",
               "age":  3
           },
           ...,
           {
               "_id":  26,
               "name": "Zoe",
               "age":  4
           }
       ]
   }

人类读者仍然可以将其视为JSON代码段/代码,概括并猜测由省略号(...)表示的“ Becky”“ Zoe”之间的模式。

但是Sphinx返回错误,因为此代码段的语法无效。

$ make html
...
/.../docs/source/sample.rst:3: WARNING: Could not lex literal_block as "json". Highlighting skipped.

我可以在代码块中使用省略号(语法高亮显示吗?请注意,该示例不必使用JSON。您还将在其他语言(例如Python)中看到此问题。

python-sphinx
1个回答
0
投票

添加选项:force:并添加自定义CSS以超过突出显示错误的位置:

.highlight .err {
    border: inherit;
    box-sizing: inherit;
}

Rendering result

© www.soinside.com 2019 - 2024. All rights reserved.