狮身人面像待办事项框未显示

Question

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

.. todo:: blah blah blah

conf.py

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

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

Answer 1

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

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

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

.. todo::

    blah
    blah

编辑：

它看起来与该站点中的有所不同，因为该站点已应用自定义CSS来实现这一点。我查看了狮身人面像的源代码，“金字塔”主题是唯一提及TODO样式的主题，但显然您可以看到您提到的站点使用默认主题。该站点具有自己的CSS文件。您应该能够将自己的CSS文件添加到“ doc / source / _static”目录，并将类似以下内容添加到conf.py中以将其包括在内：

def setup(app):
    app.add_stylesheet('my_styles.css')

特别注意其CSS文件中的部分div.admonition-todo：

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你的情况，html_static_path在 conf.py 中查看）

3) 编辑 sphinx 文档的 conf.py；在那里添加

html_style = 'custom.css'

它对我有用！

如果你想在很多项目中使用彩色的 todo 框，可以考虑编写你自己的主题：

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
}

颜色信息提示