Question

在狮身人面像中，我无法显示待办事项列表。这就是我所拥有的：

.. todo:: blah blah blah

conf.py

extensions = [
    'sphinx.ext.autodoc',
    'sphinx.ext.todo',
]

我在conf.py中尝试了sphinx.ext.todo=True，但是当我make html时出现语法错误。

Answer 1

根据此文档，您必须在配置中设置todo_include_todos。

http://sphinx-doc.org/ext/todo.html#confval-todo_include_todos

如果您遇到语法错误，请尝试（如上面文档中链接的注释示例中所示）：

.. todo::

    blah
    blah

编辑：

它与该网站看起来不一样，因为该网站已应用自定义CSS来获取该网站。我查看了sphinx源代码，“Pyramid”主题是提到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
}

Answer 2

daveydave400给出了基本答案，但我想逐步添加说明：

1）制作自定义样式表，比如custom.css

@import url("default.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
}

2）将其复制到sphinx文档的source / _static目录中（在您的情况下可能是.static，在conf.py中查看html_static_path）

3）编辑sphinx文档的conf.py;加上

html_style = 'custom.css'

它对我有用！

如果您想在许多项目中使用彩色待办事项框，请考虑编写自己的主题：

1）在custom

中创建目录Lib\site-packages\sphinx\themes

2）创建包含

的theme.conf文件

[theme]
inherit = default
stylesheet = custom.css

3）创建custom\static子目录，放置上述custom.css文件，并将其重命名为custom.css_t

4）在conf.py制作html_theme = 'custom'

事实上，你可以为任何通用警告上色。例如，你在文中有：

.. admonition:: Information

   some info

（“某些信息”之前的空行是必不可少的）

如果您制作自己的主题，可以添加到custom.css（或custom.css_t）：

div.admonition-information {
    border-top: 2px solid green;
    border-bottom: 2px solid green;
    border-left: 2px solid green;
    border-right: 2px solid green;
    background-color: #63cc47
}

为颜色信息告诫

Answer 3

三件事是必要的。

在conf.py中：

添加“ sphinx.ext.todo”扩展名。
添加“ todo_include_todos = True”参数。

具有以下指令的todo.rst文件必须存在：

.. todolist ::

狮身人面像todo盒子没有显示

3 个答案: