Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Is it possible to use POD(plain old documentation) with Python?

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

like image 455
user1597836 Avatar asked Aug 20 '12 08:08

user1597836


1 Answers

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.

like image 70
lvc Avatar answered Sep 19 '22 07:09

lvc