epydoc:固定宽度文本块

Question

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

我所知道的唯一方法是在每一行之前添加>>>，这很糟糕，因为doctest可能认为这是一个Python代码段，并失去了它的智慧。而且，它看起来真的很丑：

>>> db

>>>端口= 5432

>>>名称= adam_db

...

我真正想要的是：

数据库 port=5432 name=adam_db ..。

在固定宽度的字体中。

有什么想法吗？

谢谢,

亚当

Answer 1

也许您可以使用文字块选项。