reStructuredText中的嵌套子列表,代码块不起作用

时间:2018-01-30 14:20:49

标签: python-sphinx restructuredtext

我正在使用sphinx尝试从.rst文件创建HTML文档。我试图创建一个具有编号列表(1.,2.,...)的文档,其中包含一个嵌套的子列表(a。,b,c。,...),显示示例代码。但是我在弄清楚语法以使嵌套子列表工作时遇到了麻烦。这是我尝试过的.rst文件的示例:

===========
Tester Page
===========

Below are some test paragraphs.

1. This is a paragraph detailing a higher level step, with 3 sub-steps.
 a. This is a sub-bullet, with an example:
::

    ls -l foo.txt

 b. I can't get this line to not display as part of the code block! This is another sub-bullet, with an example:
::

    git add bar.txt

2. This is step 2.

This is the end of the document.

以上给出了类似于此的结果(很难在Markdown中完全重现,但希望你能得到这个想法):

  

Tester Page

     

以下是一些测试段落。

     
      
  1. 这是一些文字。

         

    一个。这是一个子弹,有一个例子:

  2.   
  ls -l foo.txt

b. This is another sub-bullet, with an example:
  git add bar.txt
  
      
  1. 这是第2步。
  2.         

    这是文件的结尾。

我一直在调整双冒号,空格和背引号至少一个小时,并且无法弄清楚如何让它正确格式化。也许reStructuredText的功能不足以处理嵌入式代码块的嵌套列表?

1 个答案:

答案 0 :(得分:1)

你必须非常小心垂直和水平的空白。必须使用空行将嵌套列表与父列表项分开。文字块中的代码示例必须正确缩进。

Below are some test paragraphs.

1. This is a paragraph detailing a higher level step, with 3 sub-steps.

   a. This is a sub-bullet, with an example::

         ls -l foo.txt

   b. I can get this line to display as part of the code block!
      This is another sub-bullet, with an example::

         git add bar.txt

2. This is step 2.