sphinx中方法的自定义筛选

Question

我想在我的sphinx文档中添加一个菜单“todo items”，它应该包含包含一些todo项的项目的所有方法，如下所示：

“”：todo:Fonctionà impl公司é“门托”

我想显示类的名称、相关方法的名称、行号及其内容

我发现了一些相关的东西：http://www.pythondoc.com/sphinx/ext/autodoc.html#skipping-members，但它只过滤方法，似乎没有链接到所需的信息（行号和行内容）

有办法做到这一点吗？你知道一些有用的链接吗

Answer 1

使用Sphinx扩展名^{}

将它添加到扩展列表中，并在conf.py中将todo_include_todos设置为True

然后对docstring中的todo指令使用适当的语法，注意使用适当的缩进和空格