在 sphinx 中,我无法显示待办事项列表。这是我所拥有的:
.. todo:: blah blah blah
配置文件
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.todo',
]
我在 conf.py 中尝试了 sphinx.ext.todo=True
,但是当我制作 html
时出现语法错误。
最佳答案
根据此文档,您必须在配置中设置 todo_include_todos
。
http://sphinx-doc.org/ext/todo.html#confval-todo_include_todos
如果您遇到语法错误,可以尝试(如上面文档中链接的注释示例所示):
.. todo::
blah
blah
编辑:
它看起来与该站点中的不一样,因为该站点已应用自定义 CSS 来实现这一点。我查看了 sphinx 源代码,“金字塔”主题是唯一提及 TODO 样式的主题,但您可以明显看到您提到的站点使用默认主题。该网站有它的 own CSS file .您应该能够将自己的 CSS 文件添加到您的“doc/source/_static”目录,并将类似这样的内容添加到您的 conf.py 以包含它:
def setup(app):
app.add_stylesheet('my_styles.css')
特别注意 div.admonition-todo
的 CSS 文件部分:
div.admonition-todo {
border-top: 2px solid red;
border-bottom: 2px solid red;
border-left: 2px solid red;
border-right: 2px solid red;
background-color: #ff6347
}
关于python - Sphinx 待办事项框未显示,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/22290548/