README.rst

   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: https://codeberg.org/milde/pylit/raw/branch/master/pylit.py
  21
  22
  23 Documentation
  24   `PyLit pages`_.
  25
  26 Copyright
  27   © 2005, 2009, 2022 Günter Milde.
  28
  29 License
  30   PyLit is `free software`_, released under the `GNU General Public License`_
  31   (GPL) version 3 or later.
  32
  33   PyLit is distributed in the hope that it will be useful, but WITHOUT ANY
  34   WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  35   FOR A PARTICULAR PURPOSE.  See the `GNU General Public License`_ for more
  36   details.
  37
  38
  39 .. References
  40
  41 .. _Charming Python interview:
  42     http://www.ibm.com/developerworks/library/l-pyth7.html
  43 .. _bidirectional text/code converter:
  44     https://milde.codeberg.page/PyLit/features.html#dual-source
  45 .. _literate programming:
  46     https://milde.codeberg.page/PyLit/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 .. _PyLit pages: https://milde.codeberg.page/PyLit/
  51 .. _`free software`: http://www.gnu.org/philosophy/free-sw.html
  52 .. _`GNU General Public License`: http://www.gnu.org/copyleft/gpl.html