epydoc：固定宽度文本的块

Question

我写了一个依赖于配置文件的软件组件。为了清楚起见，我想通过在相关类的docstring中添加示例文件来记录配置文件的结构。出于显而易见的原因，它应该以固定宽度的字体出现。

我知道的唯一方法是在每行之前加上>>>，这是不好的，因为doctest可能认为这是一个Python代码段并失去了智慧。此外，它看起来非常难看：

>>> [DB]

>>>端口= 5432

>>>名= adam_db

...

我真正想要的是：

[db]

端口= 5432

名称= adam_db

...

在一个固定宽度的字体。

任何想法？

感谢，

亚当

Answer 1

也许你可以使用Literal Block选项。