狮身人面像待办事项框未显示
问题描述
在狮身人面像中,我无法显示待办事项列表。以下是我所拥有的:
.. todo:: blah blah blah
conf.py
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.todo',
]
我尝试在conf.py中使用sphinx.ext.todo=True
,但在make html
时出现语法错误。
解决方案
根据本文档,您必须在配置中设置todo_include_todos
。
http://sphinx-doc.org/ext/todo.html#confval-todo_include_todos
如果出现语法错误,可以尝试(如上面文档中链接的注释示例所示):
.. todo::
blah
blah
编辑:
它看起来与该站点中的不同,因为该站点应用了定制的CSS来获得它。我看了狮身人面像的源代码,"金字塔"主题是唯一提到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
}
相关文章