Sphinx-在代码块片段中使用省略号(…)

时间:2019-12-20 21:00:51

标签: python-sphinx

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

这是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)中看到此问题。

1 个答案:

答案 0 :(得分:0)

添加选项spaCy并添加自定义CSS以禁用错误突出显示:

:force:

Rendering result