Literate programming (in python)

The slides are available here: pygraz-lp slides (HTML, 25.3 KB, ¹). Source code examples included.

Literate programming tools

What's a LP tool is defined here by “author says the tool is akin to the LP paradigm”. Everything else can be found in the list below.

• WEB (Pascal and TeX, deprecated)
• CWEB ({C, C++} and TeX)
• noweb (* and TeX, frozen)
• nuweb (* and TeX/HTML)
• Leo Editor (python and Leo)
• docco ({Coffeescript, Javascript, Ruby, Python} and HTML, Ports for {ruby, Julia, Clojure, shell, Lua, C#})

Well known documentation tools

• Sphinx Documentation Generator
• Java: Javadoc
• Doxygen
• Python: pydoc

Literate programming communities

• Website collecting information about LP
• Knuth's website about LP
• Google groups: comp.programming.literate
• outdated F.A.Q of comp.programming.literate
• Wiki-community focusing on explanation of solutions for algorithmic problems
• Is literate programming dead? at StackOverflow
• Interesting discussion about LP and Leo (see comments)
• A small demonstration of the Leo editor

Programming languages

• POD in perl
• PEP 0257: Docstring Conventions
• PEP 0287: reStructuredText Docstring Format
• PEP 0256: Docstring Processing System Framework (rejected)
• Literate Programming in Haskell (Haskell and TeX)

Literature reference

[0] “Literate programming”

by Donald E. Knuth, Cambridge University Press, 1992

[1] “Computers & Typesetting, Volume B: Tex: The Program”

by Donald E. Knuth, Addison-Wesley Longman, 1986

[2] “Computers & Typesetting, Volume D: Metafont: The Program”

by Donald E. Knuth, Addison-Wesley Longman, 1986

Copyright

• PyGraz Logo from pygraz.org (credit goes to Horst Gutmann)
• Python Logo from python.org (credit goes to Python Software Foundation)
• Donald E. Knuth portait photo from Knuth's Stanford Website (credit goes to Rajan P. Parrikar)
• Leo logo from the Leo Homepage (credit goes to Edward K. Ream)
• Fibonacci sequence Haskell implementation from haskell.org
• Rule 110 implementation in Literate Haskell (credit goes to Dept. of Computer Science, University of Kaiserslautern)
• The POD source code is part of Perl 5 (perl5/Date/Manip/Delta.pod) (credit goes to Sullivan Beck)

---

¹ The slides use the Mozilla-Firefox-specific CSS rule -moz-column-count. So the “The WEB system” slide will not be displayed properly at other browsers.