rstdocs/index.txt

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