无法在reStructuredtext(Sphinx/readthedocs)中以我想要的格式创建项目符号列表?

3 投票
1 回答
2877 浏览
提问于 2025-04-18 05:35

我正在尝试在一个编号列表中制作一个简单的嵌套项目符号列表。我有一个按数字顺序排列的列表,但当我试图在这个列表中添加一个项目符号列表时,结果却是数字。看看这个:

我想要的是这个:

1. Sample 1
     * Sub bullet 1
     * Sub bullet 2
2. Sample 2
     * Sub bullet 1

在reStructuredtext中,我是这样做的:

#. Sample 1
     * ``sub bullet 1``
     * ``sub bullet 2``
#. Sample 2
     * ``sub bullet 1``

但是在readthedocs上输出的结果变成了:

1. Sample 1
    1. Sub bullet 1
    2. Sub bullet 2
2. Sample 2
    1. Sub bullet 1

我哪里做错了?我尝试调整缩进、前后的空白行等等,但都没有成功。

1 个回答

2

看起来这是sphinx_rtd_theme里的一个小问题,这个主题现在是readthedocs的默认主题。所以你可能需要在它的github页面上提个问题。在此期间,你可以使用这个临时解决办法:

1. Sample 1

  * ``sub bullet 1``
  * ``sub bullet 2``

2. Sample 2

  * ``sub bullet 1``

这里不太好的地方是,你需要手动给你的编号列表编号,而且项目符号列表的缩进也不太正确,不过这样做可以正常生成文档,没有错误,适用于sphinx_rtd_theme。

或者你可以换一个其他的主题(比如默认主题),这样就能正确解析这种标记了。

撰写回答