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

Question

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

Answer 1

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.

Answer 2

Yes. Use '''.

#!/usr/bin/python3                                                                       

'''
=pod
                                                                                     
=head1 NAME
...
=cut
'''

import sys