首页 > 解决方案 > Readthedocs / Sphinx 不从 rst 文件中呈现项目符号列表

问题描述

我有一组我正在用 sphinx 在 readthedocs 中构建的 rst 文件。这些文件有多个项目符号列表,但它们没有正确呈现。

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

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

这是第一个应该呈现的内容(::marker对于 html 文件中的每个列表项)

在此处输入图像描述

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

在此处输入图像描述

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

标签: python-sphinxrestructuredtextread-the-docs

解决方案


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

我们正在使用nbsphinx(我们的一些文档说明了使用笔记本的操作),最近由于相关的包版本(jinja2, sphinx, docutils)而出现了一些问题。根据问题/评论(例如这个那个),我们使用了这些包的各种旧版本。

但在撰写本文时,感谢所有维护人员的辛勤工作,我们能够删除除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  

推荐阅读