doc/index.txt

   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. [1]_
  10
  11 .. meta::
  12    :description: Literate Programming with reStructuredText
  13    :keywords: reStructuredText, Docutils, software development
  14
  15 Features
  16 --------
  17
  18 PyLit (Python Literate) provides a plain but efficient tool for
  19 literate programming: a `bidirectional text/code converter`_.
  20
  21 .. toctree::
  22    :maxdepth: 2
  23
  24    features
  25
  26 .. _bidirectional text/code converter: features.html#dual-source
  27 .. _literate programming: literate-programming.html
  28
  29
  30 Documentation
  31 -------------
  32
  33 .. toctree::
  34    :maxdepth: 1
  35
  36    usage
  37    tutorial/index
  38    examples/index
  39
  40    literate-programming
  41
  42
  43 Download
  44 --------
  45
  46 .. toctree::
  47    :maxdepth: 1
  48
  49    download/index
  50
  51 Project page
  52 ------------
  53
  54 The PyLit project is hosted at https://codeberg.org/milde/pylit
  55
  56 Changes
  57 -------
  58
  59 PyLit `versions`_.
  60
  61 Usage, behaviour, and API are not fixed yet.  Ideas and feedback welcome.
  62
  63 The `PyLit source`_ has a chapter on open questions and ideas.
  64
  65 .. _versions: examples/pylit.py.html#changelog
  66
  67 .. _PyLit source: raw/master/pylit.py
  68 .. _open questions: examples/pylit.py.html#open-questions
  69
  70 Copyright
  71 ---------
  72
  73 Copyright
  74   © 2005, 2007, 2015, 2022 Günter Milde.
  75
  76 License
  77   PyLit is `free software`_, released under the `GNU General Public License`_
  78   (GPL) version 2 or later.
  79
  80   PyLit is distributed in the hope that it will be useful, but WITHOUT ANY
  81   WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  82   FOR A PARTICULAR PURPOSE.  See the `GNU General Public License`_ for more
  83   details.
  84
  85 I am using PyLit in my daily work for more than ten years now without major
  86 problems. It works for me, but your mileage might vary.
  87
  88 Remember to back up your data. A version control system is recommended.
  89
  90 .. _`free software`: http://www.gnu.org/philosophy/free-sw.html
  91 .. _`GNU General Public License`: http://www.gnu.org/copyleft/gpl.html
  92
  93
  94 About this site
  95 ---------------
  96
  97 The PyLit documentation is created from `reStructuredText`_ sources with
  98 Sphinx_. It is located at https://milde.codeberg.page/PyLit/.
  99
 100 .. _reStructuredText: https://docutils.sourceforge.io/rst.html
 101 .. _Sphinx: https://www.sphinx-doc.org/
 102
 103 .. References
 104
 105 .. [1]  John Max Skaller in a `Charming Python interview`_
 106
 107 .. _Charming Python interview:
 108     http://www.ibm.com/developerworks/library/l-pyth7.html