【问题标题】:Can't make a bullet list in reStructuredtext (Sphinx/readthedocs) in the format that I want?无法以我想要的格式在 reStructuredtext (Sphinx/readthedocs) 中制作项目符号列表?
【发布时间】:2014-06-23 15:11:57
【问题描述】:

我正在尝试在枚举列表中创建一个简单的嵌套项目符号列表。我有一个按数字顺序排列的列表,但是当我尝试在此列表中添加项目符号列表时,项目符号是数字。看看:

我想要这个:

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

我做错了什么?我尝试使用缩进、前面和后面的空白行等,但无济于事。

【问题讨论】:

  • 它对我有用;你的设置是什么?
  • 在本地使用 sphinx_rtd_theme 时,我得到了 jake9115 的输出。可以正常使用默认主题,但不能使用他们问题中提到的 readthedocs 主题。

标签: python python-sphinx restructuredtext


【解决方案1】:

这似乎是 sphinx_rtd_theme 中的一个错误,它目前用作 readthedocs 上的默认主题,因此您可能应该在它的 github 页面上填写一个问题。同时,您可以使用此解决方法:

1. Sample 1

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

2. Sample 2

  * ``sub bullet 1``

这里的坏处是您必须手动为枚举列表编号,而且项目符号列表的缩进也不是真的正确,但它可以使用 sphinx_rtd_theme 构建文档而不会出错。

或者您可以切换到正确解析此类标记的另一个主题(例如默认)。

【讨论】:

  • 太好了,我知道我不会对这个标记有那么严重的误解!很高兴使用该修复程序。
  • 上游已经修复了吗?
  • 这是从 sphinx_rtd_theme 0.5.2 开始修复的。
猜你喜欢
  • 2021-08-05
  • 1970-01-01
  • 2015-11-11
  • 2022-06-22
  • 2011-05-11
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
相关资源
最近更新 更多