6

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

Kara
  • 6,115
  • 16
  • 50
  • 57
user1597836
  • 61
  • 2
  • 2
    Why do you need that. Python has its very own docstring format which gets interpreted by `pydoc`. If you use POD, users of your module would need a tool to read it. Are you sure this is what you want? If you just want to document your code, use python's docstring. – javex Aug 20 '12 at 08:38

2 Answers2

2

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.

lvc
  • 34,233
  • 10
  • 73
  • 98
0

Yes. Use '''.

#!/usr/bin/python3                                                                       

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

import sys
Ole Tange
  • 31,768
  • 5
  • 86
  • 104