Readthedocs / Sphinx 不从 rst 文件呈现项目符号列表

如何解决Readthedocs / Sphinx 不从 rst 文件呈现项目符号列表

我有一组 rst 文件，我正在使用 sphinx 在 readthedocs 中构建这些文件。这些文件有多个项目符号列表，但未正确呈现。

文本出现，但没有项目符号或嵌套/缩进。

为了确保它不是我的文件，我从 sphinx_rtd_theme 页面 (https://github.com/readthedocs/sphinx_rtd_theme/blob/b07560bf97dad3a4266f6145bd4b662ac708ab00/docs/demo/lists_tables.rst) 直接复制粘贴

这是第一个应该呈现的内容（对于 html 文件中的每个列表项使用 Array ( [0] => HTTP/1.1 301 Moved Permanently [1] => Server: nginx [2] => Date: Sat,15 May 2021 01:57:44 GMT [3] => Content-Type: text/html [4] => Content-Length: 162 [5] => Connection: close [6] => Location: https://www.drdansiegel.com/resources/healthy_mind_platter [7] => HTTP/1.1 301 Moved Permanently [8] => Server: nginx [9] => Date: Sat,15 May 2021 01:57:45 GMT [10] => Content-Type: text/html; charset=UTF-8 [11] => Content-Length: 0 [12] => Connection: close [13] => Expires: Sat,15 May 2021 02:57:45 GMT [14] => Cache-Control: max-age=3600 [15] => X-Redirect-By: WordPress [16] => Location: https://drdansiegel.com/resources/healthy_mind_platter [17] => HTTP/1.1 404 Not Found [18] => Server: nginx [19] => Date: Sat,15 May 2021 01:57:46 GMT [20] => Content-Type: text/html; charset=UTF-8 [21] => Connection: close [22] => Vary: Accept-Encoding [23] => Expires: Wed,11 Jan 1984 05:00:00 GMT [24] => Cache-Control: no-cache,must-revalidate,max-age=0 [25] => Link: <https://drdansiegel.com/wp-json/>; rel="https://api.w.org/" ) ）

这就是我使用本地 sphinx / rtd 设置构建相同的 rst 时得到的

在我的 conf.py 或其他文件中有什么我需要修复的吗？

解决方法

在刷新我们用于发布我们的一个软件包的 conda 环境后，我们遇到了同样的问题（列表中的项目符号消失）。此处列出的其他解决方案（到目前为止）对我不起作用，但降级 docutils <0.17 起作用。

我们正在使用 nbsphinx（我们的一些文档说明了笔记本的操作），最近由于相关软件包版本（jinja2、sphinx、docutils ）。根据问题/评论（例如 this one 和 that one），我们使用了这些软件包的各种旧版本。

但在撰写本文时，由于所有维护者的辛勤工作，我们能够移除除 docutils 之外的所有引脚。 FWIW，对于我们当前的需求，我们使用的相关包子集是：

docutils                  0.16                     py38_1  
jinja2                    3.0.0              pyhd3eb1b0_0  
nbsphinx                  0.8.6              pyhd8ed1ab_1    conda-forge
sphinx                    4.0.1              pyhd3eb1b0_0  
sphinx_rtd_theme          0.4.3                      py_0  

,

我遇到了同样的问题，当使用 * 列出时，例如

* first item
* second item

在 .rst 文件中。

我发现问题在于我使用了主题 sphinx_rtd_theme，但我没有将它添加到 extensions 文件的 conf.py 中。

添加

extensions = [sphinx_rtd_theme,# other extensions
]

为我工作！

我希望这也能解决您的问题！

,

创建一个新的sphinx项目解决了这个问题

,

我在使用 Read-The-Docs 作为主题以及 Sphinx-AutoAPI 时遇到了同样的问题。根据“Pierre D”的回答，我使用以下方法将 docutils 降级：

conda install docutils=0.16

该解决方案对我有用。丢失的子弹和拉长的行距都得到了解决。我猜这个问题是由 docutils 包中的一个错误引起的，希望它很快得到修复。