是否可以在Python中使用POD(普通的旧文档)? [英] Is it possible to use POD(plain old documentation) with Python?

问题描述

我想知道是否可以在Python中使用POD(普通的旧文档)?那我该怎么办呢?

I was wondering if it is possible to use POD(plain old documentation) with Python? And how should I do it?

推荐答案

在Python文件中似乎没有直接支持的方法来使用POD内联.但是，使用 reStructuredText 记录了Python模块(包括Python标准库).通常使用 Sphinx 来完成，该工具从reStructuredText格式的文档字符串生成文档. Sphinx和rst专门设计用于填充与POD类似的细分市场.

There does not appear to be a directly supported way to use POD inline in a Python file. However, Python modules (including the Python standard library) are documented using reStructuredText. This is usually done using Sphinx, which produces documentation from reStructuredText-formatted docstrings. Sphinx and rst were specifically designed to fill a similar niche to POD.

这篇关于是否可以在Python中使用POD(普通的旧文档)?的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！