epydoc:固定宽度文本块

时间:2010-08-18 15:04:42

标签: markup fixed-width epydoc

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

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

>>> [db]

>>> port = 5432

>>> name = adam_db

...

我真正想要的是:

  

[dB]的

     

端口= 5432

     

名= adam_db

     

...

以固定宽度字体显示。

有什么想法吗?

谢谢,

亚当

1 个答案:

答案 0 :(得分:2)

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