настраиваемая фильтрация методов в sphinx

Question

Я хотел бы добавить в свою документацию по sphinx меню «todo items», которое должно содержать все методы моего проекта, содержащие некоторые todo элементы, например:

"" ": todo: Fonctionà implémenter "" "

Я хотел бы отобразить название класса, название соответствующего метода (ов), номер строки и ее содержимое.

Я нашел что-тоэто может иметь значение: http://www.pythondoc.com/sphinx/ext/autodoc.html#skipping-members,, но оно только фильтрует методы и, по-видимому, не связано с необходимой информацией (номера строк и содержимое строк).

Есть ли способ достичь этого?Знаете ли вы несколько полезных ссылок?

Answer 1

Используйте расширение Sphinx sphinx.ext.todo.

Добавьте его в свой список расширений и установите todo_include_todos на True в вашем conf.py.

Затем используйте соответствующий синтаксис для директивы todo в ваших строках документов, соблюдая правильные отступы и пробелы.