docs/sphinx_docs/index.rst

   1 .. Thun documentation master file, created by
   2    sphinx-quickstart on Sun Apr 22 15:19:55 2018.
   3    You can adapt this file completely to your liking, but it should at least
   4    contain the root `toctree` directive.
   5
   6 Thun |release| Documentation
   7 ============================
   8
   9 Thun is dialect of Joy written in Python.
  10
  11 `Joy`_ is a programming language created by Manfred von Thun that is easy to
  12 use and understand and has many other nice properties.  This Python
  13 package implements an interpreter for a dialect of Joy that attempts to
  14 stay very close to the spirit of Joy but does not precisely match the
  15 behaviour of the original version(s) written in C.  The main difference
  16 between Thun and the originals, other than being written in Python, is
  17 that it works by the "Continuation-Passing Style".
  18
  19 Joy is:
  20
  21 * `Purely Functional <https://en.wikipedia.org/wiki/Purely_functional_programming>`__
  22 * `Stack-based <https://en.wikipedia.org/wiki/Stack-oriented_programming_language>`__
  23 * `Concatinative`_ ( See also `concatenative.org <http://www.concatenative.org/wiki/view/Concatenative%20language>`__)
  24 * :doc:`Categorical <notebooks/Categorical>`
  25
  26 I hope that this package is useful in the sense that it provides an
  27 additional joy interpreter (the binary in the archive from La Trobe seems
  28 to run just fine on my modern Linux machine!)  But I also hope that you
  29 can read and understand the Python code and play with the implementation
  30 itself.
  31
  32 .. _Joy: https://en.wikipedia.org/wiki/Joy_(programming_language)
  33
  34 .. _Concatinative: https://en.wikipedia.org/wiki/Concatenative_programming_language
  35
  36
  37 Quick Start
  38 --------------------------------------------------
  39
  40 Install from `PyPI`_ in the usual way::
  41
  42     $ pip install Thun
  43
  44 To start the REPL::
  45
  46     $ python -m joy
  47
  48 Continue with :doc:`the introduction <notebooks/Intro>`.
  49
  50 .. _PyPI: https://pypi.org/project/Thun/
  51
  52
  53 Project Hosted on `OSDN`_
  54 -------------------------
  55
  56 * `Source Repository`_ (`mirror`_)
  57 * `Bug tracker`_ (`old tracker`_)
  58 * `Forums`_
  59 * `Mailing list`_
  60
  61 .. _Bug tracker: https://todo.sr.ht/~sforman/thun-der
  62 .. _old tracker: https://osdn.net/projects/joypy/ticket/
  63 .. _Forums: https://osdn.net/projects/joypy/forums/
  64 .. _Mailing list: https://osdn.net/projects/joypy/lists/
  65 .. _OSDN: https://osdn.net/projects/joypy/
  66 .. _Source Repository: https://osdn.net/projects/joypy/scm/git/Thun/
  67 .. _mirror: https://github.com/calroc/Thun
  68
  69
  70 Information on the Joy language
  71 -------------------------------
  72
  73 See `the Wikipedia article`_ and `Kevin Albrecht's mirror of Manfred von Thun's original website for the Joy Programming Language`_ for more information on the Joy language.
  74
  75 The best source (no pun intended) for learning about Joy is the
  76 information made available at the website of La Trobe University (see the
  77 mirror link above) which contains source code for the
  78 original C interpreter, Joy language source code for various functions,
  79 and a great deal of fascinating material mostly written by Von Thun on
  80 Joy and its deeper facets as well as how to program in it and several
  81 interesting aspects.  It's quite a treasure trove.
  82
  83 .. _the Wikipedia article: https://en.wikipedia.org/wiki/Joy_(programming_language)
  84
  85 .. _Kevin Albrecht's mirror of Manfred von Thun's original website for the Joy Programming Language: http://www.kevinalbrecht.com/code/joy-mirror/index.html
  86
  87
  88 Documentation on Thun Dialect
  89 -----------------------------
  90
  91 The following is specific information for this dialect of Joy.
  92
  93 .. toctree::
  94    :maxdepth: 2
  95
  96    notebooks/Intro
  97    joy
  98    stack
  99    parser
 100    pretty
 101    library
 102    lib
 103    types
 104    notebooks/index
 105
 106
 107
 108 Indices and tables
 109 ==================
 110
 111 * :ref:`genindex`
 112 * :ref:`modindex`
 113 * :ref:`search`