是否可以在 Python 中使用 POD（普通旧文档）？答案

【问题标题】：Is it possible to use POD(plain old documentation) with Python?是否可以在 Python 中使用 POD（普通旧文档）？
【发布时间】：2012-08-15 14:20:19
【问题描述】：

我想知道是否可以在 Python 中使用 POD（普通旧文档）？我该怎么做？

【问题讨论】：

你为什么需要那个。 Python 有自己的文档字符串格式，由pydoc 解释。如果您使用 POD，您的模块的用户将需要一个工具来阅读它。你确定这是你想要的吗？如果您只想记录您的代码，请使用 python 的文档字符串。
@javex 我不需要它来编写开发人员文档，而是为程序的用户编写手册页。 IIRC 文档字符串不适用于此目的。

标签： python perl-pod

【解决方案1】：

似乎没有直接支持的方式在 Python 文件中使用 POD 内联。但是，Python 模块（包括 Python 标准库）使用 reStructuredText 记录。这通常使用Sphinx 完成，它从reStructuredText 格式的文档字符串生成文档。 Sphinx 和 rst 专门设计用于填补与 POD 类似的利基市场。

【讨论】：