| 1 |
PyLit |
| 2 |
***** |
| 3 |
|
| 4 |
`Literate Programming`_ with reStructuredText_ |
| 5 |
|
| 6 |
.. epigraph:: |
| 7 |
|
| 8 |
The idea is that you do not document programs (after the fact), but |
| 9 |
write documents that *contain* the programs. |
| 10 |
|
| 11 |
-- John Max Skaller |
| 12 |
|
| 13 |
What is it |
| 14 |
PyLit (Python Literate) provides a plain but efficient tool for |
| 15 |
literate programming: a `bidirectional text/code converter`. |
| 16 |
|
| 17 |
Install |
| 18 |
Put `pylit.py`_ in Python's `Module Search Path`_. |
| 19 |
|
| 20 |
.. _pylit.py: http://github.com/gmilde/PyLit/raw/master/pylit.py |
| 21 |
|
| 22 |
Documentation |
| 23 |
coming back soon (was available at http://pylit.berlios.de) |
| 24 |
|
| 25 |
.. note: The previous host of the PyLit project, berlios.de closed at |
| 26 |
the end of 2011. |
| 27 |
|
| 28 |
Copyright |
| 29 |
© 2005, 2009 Günter Milde. |
| 30 |
|
| 31 |
License |
| 32 |
PyLit is `free software`_, released under the `GNU General Public License`_ |
| 33 |
(GPL) version 2 or later. |
| 34 |
|
| 35 |
PyLit is distributed in the hope that it will be useful, but WITHOUT ANY |
| 36 |
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS |
| 37 |
FOR A PARTICULAR PURPOSE. See the `GNU General Public License`_ for more |
| 38 |
details. |
| 39 |
|
| 40 |
|
| 41 |
.. References |
| 42 |
|
| 43 |
.. _Charming Python interview: |
| 44 |
http://www.ibm.com/developerworks/library/l-pyth7.html |
| 45 |
.. _bidirectional text/code converter: features.html#dual-source |
| 46 |
.. _literate programming: literate-programming.html |
| 47 |
.. _reStructuredText: http://docutils.sourceforge.net/rst.html |
| 48 |
.. _module search path: |
| 49 |
http://docs.python.org/tutorial/modules.html#the-module-search-path |
| 50 |
.. _`free software`: http://www.gnu.org/philosophy/free-sw.html |
| 51 |
.. _`GNU General Public License`: http://www.gnu.org/copyleft/gpl.html |