如何在Sphinx文档中启用`todo`功能?需修改哪个配置文件?
启用Sphinx Todo功能的配置文件修改方法
嗨,我来帮你搞定这个问题!要让Sphinx的.. todo::标记正常显示出来,你需要修改的是项目里的**conf.py**文件——这是Sphinx的核心配置文件,所有全局设置都在这里调整。
具体操作步骤很简单:
- 找到项目根目录(或者docs子目录)里的
conf.py文件,打开它 - 查找是否有
todo_include_todos这行配置:- 如果已经存在,把它的值从默认的
False改成True - 如果没有这行,就找个合适的位置(比如和其他扩展配置项放在一起)添加:
todo_include_todos = True
- 如果已经存在,把它的值从默认的
- 另外别忘了,要是你的项目还没启用todo扩展,得在
conf.py的extensions列表里加上'sphinx.ext.todo',比如:extensions = [ # 这里是你已有的其他扩展,比如'sphinx.ext.autodoc'之类的 'sphinx.ext.todo', ] - 最后保存文件,重新运行
sphinx-build构建文档,.. todo::的内容就会正常显示啦!
内容的提问来源于stack exchange,提问作者nyi
相关产品推荐
相关产品推荐

