rstdocs/index.txt

   1 .. -*- rst-mode -*-
   2    restindex
   3      crumb: Home
   4      page-title: PyLit
   5      file: favicon.ico
   6      file: pylit-framed-32.png
   7      file: html4css1.css
   8      file: pylit.css
   9    /restindex
  10
  11 ============================================================
  12 PyLit: Literate programming with reStructuredText
  13 ============================================================
  14
  15 Welcome at the PyLit home page. Here you will find information and
  16 material for the following topics:
  17
  18 `Literate Programming <literate-programming/>`__
  19   Philosophy, technique, and literate programming systems.
  20
  21     The idea is that you do not document programs (after the fact), but
  22     write documents that *contain* the programs.
  23
  24     -- John Max Skaller in a `Charming Python interview`_.
  25
  26 `Features <features>`__
  27   `PyLit` (Python-Literate) is a `pure Python module`_ providing a
  28   bidirectional text <--> code converter.
  29
  30   A literate program source can be either in "text" or "code" format.
  31
  32   * The "code" source can be debugged, compiled or executed with standard
  33     tools.
  34
  35   * The "text" source can be converted to HTML or LaTeX documents with the
  36     Python Docutils_.
  37
  38 Download_, Installation_, Usage_
  39   PyLit requires functioning Python_ installation and the `pylit.py`_  module.
  40   Installation_ and usage_ are straightforward.
  41
  42   Docutils_ can be used for conversion of the text source to HTML, LaTeX, or
  43   PDF formats.
  44
  45 .. _download:  download/index.html#download
  46 .. _installation: download/index.html#installation
  47 .. _usage: download/index.html#usage
  48
  49 `Tutorial <tutorial>`__
  50   How to write literate programs with PyLit.
  51
  52 `Examples <examples>`__
  53   Use cases for literate programming with PyLit.
  54
  55 `Project page`_
  56   The PyLit project is hosted at `BerliOS Developer`_. The `project page`_
  57   provides project statistics and info as well as links to the
  58   Bugtracker_, `Feature Requests`_, pylit-users `Mail List`_, and
  59   the `SVN repository`_.
  60
  61 .. _`project page`: http://developer.berlios.de/projects/pylit/
  62 .. _BerliOS Developer: http://www.berlios.de
  63 .. _Bugtracker: http://developer.berlios.de/bugs/?group_id=7974
  64 .. _`Feature requests`: http://developer.berlios.de/feature/?group_id=7974
  65 .. _`Mail List`: http://developer.berlios.de/mail/?group_id=7974
  66 .. _`SVN repository`: http://svn.berlios.de/wsvn/pylit
  67
  68
  69 Changes_
  70   Usage, behaviour, and API are not fixed yet.
  71   Ideas and feedback welcome.
  72
  73 .. _changes: examples/pylit.py.html#changelog
  74
  75
  76 No Warranty
  77   PyLit is distributed in the hope that it will be useful, but WITHOUT ANY
  78   WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  79   FOR A PARTICULAR PURPOSE.  See the `GNU General Public License`_ for more
  80   details.
  81
  82   I am using PyLit in my daily work for more than two years now without
  83   major problems.
  84   It works for me, but your mileage might vary.
  85
  86   Remember to back up your data. I recomend to use a version control system
  87   for code and text development.
  88
  89 Copyright
  90   © 2005, 2006, 2007 Günter Milde.
  91
  92   PyLit is `free software`_, released under the `GNU General Public License`_
  93   (GPL)
  94
  95 About this site
  96   The PyLit home page is located at http://pylit.berlios.de/
  97
  98   This site is created from `reStructuredText`_ sources with Docutils_ and
  99   the rest2web_ site builder.
 100
 101   `BerliOS Developer`_ is a free (and ad-free!) service to Open Source
 102   developers by the Fraunhofer-Institut für Offene Kommunikationssysteme
 103   (FOKUS) in Berlin.
 104
 105 .. _Charming Python interview:
 106      http://www-128.ibm.com/developerworks/library/l-pyth7.html
 107 .. _reStructuredText: http://docutils.sourceforge.net/rst.html
 108 .. _rest2web: http://www.voidspace.org.uk/python/rest2web/
 109
 110 .. _pylit.py: http://svn.berlios.de/svnroot/repos/pylit/trunk/src/pylit.py
 111 .. _Python: http:www.python.org
 112 .. _Docutils: http://docutils.sourceforge.net/
 113 .. _pure Python module:
 114     http://python.org/doc/2.2.3/dist/simple-example.html#SECTION000220000000000000000
 115
 116 .. _`free software`: http://www.gnu.org/philosophy/free-sw.html
 117 .. _`GNU General Public License`: http://www.gnu.org/copyleft/gpl.html