Как запустить doctest с примерами в блоках кода уценки для mkdocs? ⇐ Python

[Anonymous]

Я использую mkdocs и mkdocstring для создания документации и включения примеров кода в строки документации. Я также использую doctest (через pytest --doctest-modules) для проверки всех этих примеров.
Вариант 1 – формат документации
Если я отформатирую строку документации следующим образом:

Код: Выделить всё

    """
Recursively flattens a nested iterable (including strings!) and returns all elements in order left to right.

Examples:
--------
```
>>> [x for x in flatten([1,2,[3,4,[5],6],7,[8,9]])]
[1, 2, 3, 4, 5, 6, 7, 8, 9]
```
"""

Тогда он хорошо отображается в документации, но doctest завершается с ошибкой:

Код: Выделить всё

Expected:
[1, 2, 3, 4, 5, 6, 7, 8, 9]
```
Got:
[1, 2, 3, 4, 5, 6, 7, 8, 9]

Это имеет смысл, поскольку doctest обрабатывает все до тех пор, пока пустая строка не будет соответствовать ожидаемому результату и стремится соответствовать точно
Вариант 2 – формат для doctest
Если я форматирую строку документации для doctest без блоков кода:

Код: Выделить всё

    """
Recursively flattens a nested iterable (including strings!) and returns all elements in order left to right.

Examples:
--------
>>> [x for x in flatten([1,2,[3,4,[5],6],7,[8,9]])]
[1, 2, 3, 4, 5, 6, 7, 8, 9]
"""

затем doctest проходит, но документация отображается



[x for x in Flatten([1,2,[3,4,[5],6],7,[8,9]])][1, 2, 3, 4, 5, 6, 7, 8, 9]



Обходной путь? - добавить пустую строку для doctest
Если я отформатирую его с дополнительной пустой строкой перед концом кодового блока:

Код: Выделить всё

    """
Recursively flattens a nested iterable (including strings!) and returns all elements in order left to right.

Examples:
--------
```
>>> [x for x in flatten([1,2,[3,4,[5],6],7,[8,9]])]
[1, 2, 3, 4, 5, 6, 7, 8, 9]

```
"""

Затем доктест проходит, но

• внизу примера в документации есть пустая строка (некрасиво)
• Мне нужно не забыть добавить пустую строку в конце каждого примера (может привести к ошибкам и раздражает)

Кто-нибудь знает лучшее решение?>

Подробнее здесь: https://stackoverflow.com/questions/780 ... for-mkdocs