doc/index.txt

   1 .. -*- rst-mode -*-
   2
   3 PyLit
   4 *****
   5
   6 `Literate Programming`_ with reStructuredText_
   7
   8 .. epigraph::
   9
  10    The idea is that you do not document programs (after the fact), but
  11    write documents that *contain* the programs. [1]_
  12
  13 Features
  14 --------
  15
  16 PyLit (Python Literate) provides a plain but efficient tool for
  17 literate programming: a `bidirectional text/code converter`_.
  18
  19 .. toctree::
  20    :maxdepth: 2
  21
  22    features
  23
  24 .. _bidirectional text/code converter: features.html#dual-source
  25 .. _literate programming: literate-programming.html
  26
  27
  28 Documentation
  29 -------------
  30
  31 .. toctree::
  32    :maxdepth: 1
  33
  34    usage
  35    tutorial/index
  36    examples/index
  37
  38    literate-programming
  39
  40
  41 Download
  42 --------
  43
  44 .. toctree::
  45    :maxdepth: 1
  46
  47    download/index
  48
  49 Project page
  50 ------------
  51
  52 The PyLit project is hosted at `BerliOS`_. The `project page`_
  53 provides project statistics and info as well as links to the
  54
  55 * Bugtracker_,
  56 * `Feature Requests`_,
  57 * pylit-users `Mail List`_, and
  58 * the `SVN repository`_.
  59
  60 .. _`project page`: http://developer.berlios.de/projects/pylit/
  61 .. _BerliOS: http://www.berlios.de
  62 .. _Bugtracker: http://developer.berlios.de/bugs/?group_id=7974
  63 .. _`Feature requests`: http://developer.berlios.de/feature/?group_id=7974
  64 .. _`Mail List`: http://developer.berlios.de/mail/?group_id=7974
  65 .. _`SVN repository`: http://svn.berlios.de/wsvn/pylit
  66
  67
  68 Changes
  69 -------
  70
  71 PyLit `versions`_ and `SVN log`_.
  72
  73 Usage, behaviour, and API are not fixed yet.  Ideas and feedback welcome.
  74
  75 The `PyLit source`_ has a chapter on `open questions`_ and ideas.
  76
  77 .. _versions: examples/pylit.py.html#changelog
  78 .. _SVN log: http://svn.berlios.de/wsvn/pylit/?op=log
  79
  80 .. _PyLit source: examples/pylit.py.html
  81 .. _open questions: examples/pylit.py.html#open-questions
  82
  83 Copyright
  84 ---------
  85
  86 Copyright
  87   © 2005, 2009 Günter Milde.
  88
  89 License
  90   PyLit is `free software`_, released under the `GNU General Public License`_
  91   (GPL)
  92
  93   PyLit is distributed in the hope that it will be useful, but WITHOUT ANY
  94   WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  95   FOR A PARTICULAR PURPOSE.  See the `GNU General Public License`_ for more
  96   details.
  97
  98 I am using PyLit in my daily work for more than two years now without major
  99 problems. It works for me, but your mileage might vary.
 100
 101 Remember to back up your data. A version control system is recommended.
 102
 103 .. _`free software`: http://www.gnu.org/philosophy/free-sw.html
 104 .. _`GNU General Public License`: http://www.gnu.org/copyleft/gpl.html
 105
 106
 107 About this site
 108 ---------------
 109
 110 The PyLit site is created from `reStructuredText`_ sources with Sphinx_.
 111 (Earlier versions used the rest2web_ site builder.)
 112
 113 It is located at http://pylit.berlios.de/ on `BerliOS`_, a free
 114 (and ad-free!) service to Open Source developers by the Fraunhofer-Institut
 115 für Offene Kommunikationssysteme (FOKUS) in Berlin.
 116
 117 .. [1]  John Max Skaller in a `Charming Python interview`_
 118
 119 .. _reStructuredText: http://docutils.sourceforge.net/rst.html
 120 .. _rest2web: http://www.voidspace.org.uk/python/rest2web/
 121 .. _Sphinx: http://sphinx.pocoo.org/
 122
 123
 124 .. _Python: http://www.python.org
 125 .. _Docutils: http://docutils.sourceforge.net/
 126
 127 .. _Charming Python interview:
 128     http://www.ibm.com/developerworks/library/l-pyth7.html