This document discusses Python documentation tools including docstrings, pydoc, IPython, doctest, and Sphinx. Docstrings provide documentation for modules, classes, and methods and can be accessed via the __doc__ attribute. Pydoc generates documentation from docstrings. IPython provides an enhanced interactive Python shell. Doctests embed examples in docstrings to test documentation. Sphinx can generate documentation from docstrings and external files in multiple formats.

1. Python
wzyang@kkbox.com

2. • docstring
• pydoc
• ipython
• doctest
• sphinx

3. docstring

4. docstring
• Class Method
Class Method
• Class Method
__doc__

5. class MyClass():
def plus(self, x):
return x + 1
mc = MyClass()
y = mc.plus(1)

6. 'This is a module'
class MyClass():
'This is my Class'
def plus(self, x):
'The method pluses one.'
return x + 1
mc = MyClass()
print mc.__doc__
print mc.plus.__doc__

7. 'This is a module'
class MyClass():
def plus(self, x):
return x + 1
import sys
print sys.modules[__name__].__doc__

8. pydoc

9. $pydoc MyClass

11. $pydoc -p 8080

13. ipython.
A better interactive mode.
$easy_install ipython

16. doctest

17. class MyClass():
def plus(self, x):
'''
The method pluses one.
>>> mc = MyClass()
>>> mc.plus(1)
2
'''
return x + 1
if __name__ == '__main__':
import doctest
doctest.testmod()

19. Sphinx
$easy_install sphinx

20. $sphinx-quickstart

22. :mod:`MyClass` Module
+++++++++++++++++++++
This is my class...
.. autoclass:: MyClass.MyClass
:members:

23. $make html